Skip to content

Commit 26d42b9

Browse files
committed
documentation edit to reflect the change
1 parent 0a221b6 commit 26d42b9

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

.env.sample

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
TOKEN=ghp_TKN
2-
LEVEL=organization # repository, organization
2+
LEVEL=organization_only # repository_only, organization_only, or organization_and_repository
33
REPO=repo-name
44
ORG=org-name
55
DEBUG=true

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,16 +57,17 @@ npm install
5757
Create a `.env` file by using our sample configuration file `.env.sample`:
5858
```text
5959
TOKEN=ghp_TKN
60-
LEVEL=repository
60+
LEVEL=repository_only # repository_only, organization_only, or organization_and_repository
6161
REPO=repo-name
6262
ORG=org-name
6363
DEBUG=false
6464
POLICIES_PATH=policies
6565
```
6666

6767
where `LEVEL` is the scope of the checks:
68-
- `repository` for repository-level checks
69-
- `organization` for organization-level checks
68+
- `repository_only` for repository-level checks
69+
- `organization_only` for organization-level checks
70+
- `organization_and_repository` for organization-level and repositorty_level checks for all the repos in the organization
7071

7172
Next, generate a Personal Access Token (PAT) from GitHub and input your settings into the `.env` file. Ensure your token has these permissions:
7273
- `repo: admin`
@@ -120,7 +121,7 @@ jobs:
120121
repo: ${{ github.repository }}
121122
org: ${{ github.repository_owner }}
122123
token: ${{ TOKEN }}
123-
level: 'organization'
124+
level: 'organization_only'
124125
policy-dir: './policies'
125126
```
126127

0 commit comments

Comments
 (0)