-
Notifications
You must be signed in to change notification settings - Fork 50
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adjust docs and GitHub action for v0.7.0 release
- Loading branch information
Showing
4 changed files
with
21 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,14 +10,14 @@ | |
|
||
## | ||
The [Codeowners Validator](https://github.com/mszostok/codeowners-validator) is available as a GitHub Action. | ||
|
||
<p align="center"> | ||
<img src="https://raw.githack.com/mszostok/codeowners-validator/main/docs/assets/action-output.png" width="600px" alt="demo"> | ||
</p> | ||
|
||
|
||
## Usage | ||
|
||
Create a workflow (eg: `.github/workflows/sanity.yml` see [Creating a Workflow file](https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file)) | ||
|
||
```yaml | ||
|
@@ -35,7 +35,7 @@ jobs: | |
# Checks-out your repository, which is validated in the next step | ||
- uses: actions/checkout@v2 | ||
- name: GitHub CODEOWNERS Validator | ||
uses: mszostok/codeowners-validator@v0.6.0 | ||
uses: mszostok/codeowners-validator@v0.7.0 | ||
# input parameters | ||
with: | ||
# "The list of checks that will be executed. By default, all checks are executed. Possible values: files,owners,duppatterns,syntax" | ||
|
@@ -46,27 +46,30 @@ jobs: | |
|
||
# GitHub access token is required only if the `owners` check is enabled | ||
github_access_token: "${{ secrets.OWNERS_VALIDATOR_GITHUB_SECRET }}" | ||
|
||
# The GitHub base URL for API requests. Defaults to the public GitHub API, but can be set to a domain endpoint to use with GitHub Enterprise. | ||
github_base_url: "https://api.github.com/" | ||
|
||
# The GitHub upload URL for uploading files. It is taken into account only when the GITHUB_BASE_URL is also set. If only the GITHUB_BASE_URL is provided then this parameter defaults to the GITHUB_BASE_URL value. | ||
github_upload_url: "https://uploads.github.com/" | ||
|
||
# The repository path in which CODEOWNERS file should be validated." | ||
repository_path: "." | ||
|
||
# Defines the level on which the application should treat check issues as failures. Defaults to warning, which treats both errors and warnings as failures, and exits with error code 3. Possible values are error and warning. Default: warning" | ||
check_failure_level: "warning" | ||
|
||
# The comma-separated list of patterns that should be ignored by not-owned-checker. For example, you can specify * and as a result, the * pattern from the CODEOWNERS file will be ignored and files owned by this pattern will be reported as unowned unless a later specific pattern will match that path. It's useful because often we have default owners entry at the begging of the CODOEWNERS file, e.g. * @global-owner1 @global-owner2" | ||
not_owned_checker_skip_patterns: "" | ||
|
||
# The owner and repository name. For example, gh-codeowners/codeowners-samples. Used to check if GitHub team is in the given organization and has permission to the given repository." | ||
owner_checker_repository: "${{ github.repository }}" | ||
|
||
# The comma-separated list of owners that should not be validated. Example: @owner1,@owner2,@org/team1,[email protected]." | ||
owner_checker_ignored_owners: "@ghost" | ||
|
||
# Specifies whether CODEOWNERS may have unowned files. For example, `/infra/oncall-rotator/oncall-config.yml` doesn't have owner and this is not reported. | ||
owner_checker_allow_unowned_patterns: "true" | ||
``` | ||
|
||
The best is to run this as a cron job and not only if you applying changes to CODEOWNERS file itself, e.g. the CODEOWNERS file can be invalidate when you removing someone from the organization. | ||
|
@@ -77,6 +80,6 @@ The best is to run this as a cron job and not only if you applying changes to CO | |
|
||
## Configuration | ||
|
||
For the GitHub Action, use the configuration described in the main README under the [Configuration](../README.md#configuration) section but **specify it as the [Action input parameters](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepswith) instead of environment variables**. See the [Usage](#usage) section for the full syntax. | ||
For the GitHub Action, use the configuration described in the main README under the [Configuration](../README.md#configuration) section but **specify it as the [Action input parameters](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepswith) instead of environment variables**. See the [Usage](#usage) section for the full syntax. | ||
|
||
If you want to use environment variables anyway, you must add the `INPUT_` prefix to each environment variable. For example, `OWNER_CHECKER_IGNORED_OWNERS` becomes `INPUT_OWNER_CHECKER_IGNORED_OWNERS`. |