forked from mszostok/codeowners-validator
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Mariah Arnold
authored and
Rebecca Dadlani
committed
Jan 5, 2022
1 parent
4d2b783
commit 1df0da3
Showing
36 changed files
with
82 additions
and
78 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
# Ignore everything | ||
** | ||
#** | ||
|
||
# Allow binary | ||
!/codeowners-validator | ||
#!/codeowners-validator |
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 |
---|---|---|
|
@@ -11,7 +11,7 @@ | |
|
||
## Codeowners Validator | ||
<a href="/LICENSE"><img alt="Software License" src="https://img.shields.io/badge/license-Apache-brightgreen.svg?style=flat-square"/></a> | ||
<a href="https://goreportcard.com/report/github.com/mszostok/codeowners-validator"><img alt="Go Report Card" src="https://goreportcard.com/badge/github.com/mszostok/codeowners-validator?style=flat-square"/></a> | ||
<a href="https://goreportcard.com/report/github.com/stitchfix/codeowners-validator"><img alt="Go Report Card" src="https://goreportcard.com/badge/github.com/stitchfix/codeowners-validator?style=flat-square"/></a> | ||
<a href="https://twitter.com/m_szostok"><img alt="Twitter Follow" src="https://img.shields.io/twitter/follow/m_szostok?color=a&label=Follow%20%40m_szostok%20for%20updates&style=social"></a> | ||
|
||
The Codeowners Validator project validates the GitHub [CODEOWNERS](https://help.github.com/articles/about-code-owners/) file based on [specified checks](#checks). It supports public and private GitHub repositories and also GitHub Enterprise installations. | ||
|
@@ -29,7 +29,7 @@ docker run --rm -v $(pwd):/repo -w /repo \ | |
-e GITHUB_ACCESS_TOKEN="$GH_TOKEN" \ | ||
-e EXPERIMENTAL_CHECKS="notowned" \ | ||
-e OWNER_CHECKER_REPOSITORY="org-name/rep-name" \ | ||
mszostok/codeowners-validator:v0.6.0 | ||
stitchfix/codeowners-validator:v0.6.0 | ||
``` | ||
|
||
#### Command line | ||
|
@@ -46,7 +46,7 @@ env REPOSITORY_PATH="." \ | |
#### GitHub Action | ||
|
||
```yaml | ||
- uses: mszostok/[email protected] | ||
- uses: stitchfix/[email protected] | ||
with: | ||
checks: "files,owners,duppatterns" | ||
experimental_checks: "notowned" | ||
|
@@ -62,31 +62,31 @@ Check the [Configuration](#configuration) section for more info on how to enable | |
## Installation | ||
It's highly recommended to install a fixed version of `codeowners-validator`. Releases are available on the [releases page](https://github.com/mszostok/codeowners-validator/releases). | ||
It's highly recommended to install a fixed version of `codeowners-validator`. Releases are available on the [releases page](https://github.com/stitchfix/codeowners-validator/releases). | ||
|
||
#### From Release | ||
|
||
Here is the recommended way to install `codeowners-validator`: | ||
|
||
```bash | ||
# binary installed into ./bin/ | ||
curl -sfL https://raw.githubusercontent.com/mszostok/codeowners-validator/main/install.sh | sh -s v0.6.0 | ||
curl -sfL https://raw.githubusercontent.com/stitchfix/codeowners-validator/main/install.sh | sh -s v0.6.0 | ||
# binary installed into $(go env GOPATH)/bin/codeowners-validator | ||
curl -sfL https://raw.githubusercontent.com/mszostok/codeowners-validator/main/install.sh | sh -s -- -b $(go env GOPATH)/bin v0.6.0 | ||
curl -sfL https://raw.githubusercontent.com/stitchfix/codeowners-validator/main/install.sh | sh -s -- -b $(go env GOPATH)/bin v0.6.0 | ||
# In alpine linux (as it does not come with curl by default) | ||
wget -O - -q https://raw.githubusercontent.com/mszostok/codeowners-validator/main/install.sh | sh -s v0.6.0 | ||
wget -O - -q https://raw.githubusercontent.com/stitchfix/codeowners-validator/main/install.sh | sh -s v0.6.0 | ||
# Print version. Add `--short` to print just the version number. | ||
codeowners-validator -v | ||
``` | ||
|
||
You can also download [latest version](https://github.com/mszostok/codeowners-validator/releases/latest) from release page manually. | ||
You can also download [latest version](https://github.com/stitchfix/codeowners-validator/releases/latest) from release page manually. | ||
|
||
#### From Sources | ||
|
||
You can install `codeowners-validator` with `go install github.com/mszostok/[email protected]`. | ||
You can install `codeowners-validator` with `go install github.com/stitchfix/[email protected]`. | ||
|
||
> NOTE: please use Go 1.16 or greater. | ||
|
@@ -148,6 +148,6 @@ Contributions are greatly appreciated! The project follows the typical GitHub pu | |
|
||
## Roadmap | ||
|
||
The [codeowners-validator roadmap uses Github milestones](https://github.com/mszostok/codeowners-validator/milestone/1) to track the progress of the project. | ||
The [codeowners-validator roadmap uses Github milestones](https://github.com/stitchfix/codeowners-validator/milestone/1) to track the progress of the project. | ||
|
||
They are sorted with priority. First are most important. |
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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 |
---|---|---|
|
@@ -9,10 +9,10 @@ | |
</p> | ||
|
||
## | ||
The [Codeowners Validator](https://github.com/mszostok/codeowners-validator) is available as a GitHub Action. | ||
The [Codeowners Validator](https://github.com/stitchfix/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"> | ||
<img src="https://raw.githack.com/stitchfix/codeowners-validator/main/docs/assets/action-output.png" width="600px" alt="demo"> | ||
</p> | ||
|
||
|
||
|
@@ -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/[email protected].0 | ||
uses: stitchfix/[email protected].5 | ||
# input parameters | ||
with: | ||
# "The list of checks that will be executed. By default, all checks are executed. Possible values: files,owners,duppatterns,syntax" | ||
|
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 |
---|---|---|
@@ -1,4 +1,4 @@ | ||
module github.com/mszostok/codeowners-validator | ||
module github.com/stitchfix/codeowners-validator | ||
|
||
go 1.17 | ||
|
||
|
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
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 |
---|---|---|
|
@@ -4,7 +4,7 @@ import ( | |
"context" | ||
"testing" | ||
|
||
"github.com/mszostok/codeowners-validator/internal/check" | ||
"github.com/stitchfix/codeowners-validator/internal/check" | ||
|
||
"github.com/stretchr/testify/assert" | ||
"github.com/stretchr/testify/require" | ||
|
@@ -22,7 +22,7 @@ func TestDuplicatedPattern(t *testing.T) { | |
/build/logs/ @doctocat | ||
/build/logs/ @doctocat | ||
/script @mszostok | ||
/script @stitchfix | ||
/script [email protected] | ||
`, | ||
expectedIssues: []check.Issue{ | ||
|
@@ -37,7 +37,7 @@ func TestDuplicatedPattern(t *testing.T) { | |
Severity: check.Error, | ||
LineNo: nil, | ||
Message: `Pattern "/script" is defined 2 times in lines: | ||
* 7: with owners: [@mszostok] | ||
* 7: with owners: [@stitchfix] | ||
* 8: with owners: [[email protected]]`, | ||
}, | ||
}, | ||
|
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
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
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
Oops, something went wrong.