Skip to content

Commit

Permalink
Add config information
Browse files Browse the repository at this point in the history
Signed-off-by: John Mertic <[email protected]>
  • Loading branch information
jmertic authored Nov 21, 2024
1 parent f75d3c3 commit 2b25791
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,23 @@ It is an evolution of the former [landscape-tools](https://github.com/jmertic/la
- Pull review data from a TAC repo using a specific project format, if used.
- More verbose error messages that improve debugging.

## Configuration

The default configuration for the build is located in the `config.yml` file, which you should put in the top directory in your landscape repo ( i.e. the same place you would have the `landscape.yml` file ). All options are defined at [lfx_landscape_tools/config.py](lfx_landscape_tools/config.py). See the below example for a simple `config.yml` file for building a members-only landscape.

```yaml
# Membership levels; name is the membership level name in LFX; category is the matching subcategory name in the landscape
landscapeMemberClasses:
- name: Steering Membership
category: Steering
- name: General Membership
category: General
# Slug for the project from LFX
slug: alliance-for-open-usd-fund-aousdf
# Category name for members
landscapeMemberCategory: AOUSD Members
```
## Setting up the GitHub Action
1) Add [secrets](https://docs.github.com/en/actions/reference/encrypted-secrets) for `PAT`, which is a [GitHub Personal Authorization Token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) set for the `repo` scope.
Expand Down

0 comments on commit 2b25791

Please sign in to comment.