diff --git a/.github/pull-request-template.md b/.github/pull-request-template.md index e897967..60ab880 100644 --- a/.github/pull-request-template.md +++ b/.github/pull-request-template.md @@ -4,9 +4,7 @@ Changes proposed in this pull request: -- ... -- ... -- ... +- **Related issue(s)** diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml index 7573e6e..2f5df82 100644 --- a/.github/workflows/codeql-analysis.yml +++ b/.github/workflows/codeql-analysis.yml @@ -2,10 +2,10 @@ name: "CodeQL" on: push: - branches: [ master ] + branches: [ $default-branch ] pull_request: # The branches below must be a subset of the branches above - branches: [ master ] + branches: [ $default-branch ] schedule: - cron: '15 15 * * 2' diff --git a/.github/workflows/pull-requests.yml b/.github/workflows/pull-requests.yml index c1ccf1e..4ecf672 100644 --- a/.github/workflows/pull-requests.yml +++ b/.github/workflows/pull-requests.yml @@ -2,7 +2,7 @@ name: Pull request on: pull_request: - branches: [ master ] + branches: [ $default-branch ] env: GO111MODULE: on diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 471301a..b47ebec 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -37,10 +37,10 @@ To start contributing, follow these steps: git fetch --all ``` -5. Set the master branch to point to upstream: +5. Set the `main` branch to point to upstream: ```bash - git branch -u upstream/master master + git branch -u upstream/main main ``` You're all set! 🚀 Read the [development](./docs/development.md) document for further instructions. diff --git a/README.md b/README.md index 8b11896..fd06457 100644 --- a/README.md +++ b/README.md @@ -10,11 +10,9 @@
## Codeowners Validator -Twitter Follow - Software License Go Report Card -Travis +Twitter Follow 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. @@ -72,13 +70,13 @@ Here is the recommended way to install `codeowners-validator`: ```bash # binary installed into ./bin/ -curl -sfL https://raw.githubusercontent.com/mszostok/codeowners-validator/master/install.sh | sh -s v0.6.0 +curl -sfL https://raw.githubusercontent.com/mszostok/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/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v0.6.0 +curl -sfL https://raw.githubusercontent.com/mszostok/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/master/install.sh | sh -s v0.6.0 +wget -O - -q https://raw.githubusercontent.com/mszostok/codeowners-validator/main/install.sh | sh -s v0.6.0 # Print version. Add `--short` to print just the version number. codeowners-validator -v diff --git a/docs/assets/usage.svg b/docs/assets/usage.svg index 856854a..687ed61 100644 --- a/docs/assets/usage.svg +++ b/docs/assets/usage.svg @@ -1 +1 @@ -OWNER_CHECKER_ORGANIZATION_NAME="gh-codeowners"\▲▲#Downloadcodeowners-validatorbinary/binv0.2.0▲curl-sfLhttps://raw.githubusercontent.com/mszostok/codeowners-validator/master/install.sh|sh-s---b/usr/local/binv0.2.0mszostok/codeowners-validatorinfocheckingGitHubfortag'v0.2.0'mszostok/codeowners-validatorinfofoundversion:0.2.0forv0.2.0/Darwin/x86_64mszostok/codeowners-validatorinfoinstalled/usr/local/bin/codeowners-validator▲#CloneexamplerepositorywithsampleCODEOWNERS▲#CloneexamplerepositorywithsampleCODEOWNERS▲gitclonegit@github.com:gh-codeowners/codeowners-samples.gitCloninginto'codeowners-samples'...remote:Enumeratingobjects:8,done.remote:Countingobjects:100%(8/8),done.remote:Compressingobjects:100%(3/3),done.remote:Total8(delta0),reused8(delta0),pack-reused0Receivingobjects:100%(8/8),done.▲#Executecodeowners-validatoragainstclonedrepository▲#Executecodeowners-validatoragainstclonedrepositoryEXPERIMENTAL_CHECKS="notowned"\GITHUB_ACCESS_TOKEN="${GH_TOKEN}"\▲#Downloadcodeowners-validatorbinarycodeowners-validator▲envREPOSITORY_PATH="./codeowners-samples"\EXPERIMENTAL_CHECKS="notowned"\GITHUB_ACCESS_TOKEN="${GH_TOKEN}"\OWNER_CHECKER_ORGANIZATION_NAME="gh-codeowners"\codeowners-validator==>ExecutingFileExistChecker(1.240501ms)[err]line13:"/scripts/"doesnotmatchanyfilesinrepository==>ExecutingDuplicatedPatternChecker(1.820841ms)[err]Pattern"/some/awesome/dir"isdefined2timesinlines:*10:withowners:[@mszostok@owner-a]*11:withowners:[@octocat]==>Executing[Experimental]NotOwnedFileChecker(38.920431ms)CheckOK==>ExecutingValidOwnerChecker(1.238375347s)[err]line8:User"@mszostok"isnotamemberoftheorganization[err]line10:User"@owner-a"doesnothavegithubaccount[err]line11:User"@octocat"isnotamemberoftheorganization4check(s)executed,3failure(s)▲▲#Downloadcodeowners-validatorbinary▲#Downloadcodeowners-validatorbinary▲#Downloadcodeowners-validatorbinary▲curl-sfLhttps://raw.githubusercontent.com/mszostok/codeowners-validator/master/install.sh|sh-s---b/usr/local▲curl-sfLhttps://raw.githubusercontent.com/mszostok/codeowners-validator/master/install.sh|sh-s---b/usr/local▲curl-sfLhttps://raw.githubusercontent.com/mszostok/codeowners-validator/master/install.sh|sh-s---b/usr/local▲curl-sfLhttps://raw.githubusercontent.com/mszostok/codeowners-validator/master/install.sh|sh-s---b/usr/local▲curl-sfLhttps://raw.githubusercontent.com/mszostok/codeowners-validator/master/install.sh|sh-s---b/usr/local▲curl-sfLhttps://raw.githubusercontent.com/mszostok/codeowners-validator/master/install.sh|sh-s---b/usr/local▲curl-sfLhttps://raw.githubusercontent.com/mszostok/codeowners-validator/master/install.sh|sh-s---b/usr/local▲curl-sfLhttps://raw.githubusercontent.com/mszostok/codeowners-validator/master/install.sh|sh-s---b/usr/local▲curl-sfLhttps://raw.githubusercontent.com/mszostok/codeowners-validator/master/install.sh|sh-s---b/usr/local▲curl-sfLhttps://raw.githubusercontent.com/mszostok/codeowners-validator/master/install.sh|sh-s---b/usr/local▲curl-sfLhttps://raw.githubusercontent.com/mszostok/codeowners-validator/master/install.sh|sh-s---b/usr/local▲curl-sfLhttps://raw.githubusercontent.com/mszostok/codeowners-validator/master/install.sh|sh-s---b/usr/local▲curl-sfLhttps://raw.githubusercontent.com/mszostok/codeowners-validator/master/install.sh|sh-s---b/usr/local▲curl-sfLhttps://raw.githubusercontent.com/mszostok/codeowners-validator/master/install.sh|sh-s---b/usr/local▲curl-sfLhttps://raw.githubusercontent.com/mszostok/codeowners-validator/master/install.sh|sh-s---b/usr/local▲curl-sfLhttps://raw.githubusercontent.com/mszostok/codeowners-validator/master/install.sh|sh-s---b/usr/local▲curl-sfLhttps://raw.githubusercontent.com/mszostok/codeowners-validator/master/install.sh|sh-s---b/usr/local/binv0.2.0/binv0.2.0/binv0.2.0/binv0.2.0▲#CloneexamplerepositorywithsampleCODEOWNERS▲#CloneexamplerepositorywithsampleCODEOWNERS▲#CloneexamplerepositorywithsampleCODEOWNERS▲#CloneexamplerepositorywithsampleCODEOWNERS▲#CloneexamplerepositorywithsampleCODEOWNERS▲gitclonegit@github.com:gh-codeowners/codeowners-samples.git▲gitclonegit@github.com:gh-codeowners/codeowners-samples.git▲gitclonegit@github.com:gh-codeowners/codeowners-samples.git▲gitclonegit@github.com:gh-codeowners/codeowners-samples.git▲gitclonegit@github.com:gh-codeowners/codeowners-samples.git▲gitclonegit@github.com:gh-codeowners/codeowners-samples.git▲gitclonegit@github.com:gh-codeowners/codeowners-samples.git▲gitclonegit@github.com:gh-codeowners/codeowners-samples.git▲gitclonegit@github.com:gh-codeowners/codeowners-samples.git▲gitclonegit@github.com:gh-codeowners/codeowners-samples.gitReceivingobjects:12%(1/8)Receivingobjects:100%(8/8)▲#Executecodeowners-validatoragainstclonedrepository▲#Executecodeowners-validatoragainstclonedrepository▲#Executecodeowners-validatoragainstclonedrepository▲#Executecodeowners-validatoragainstclonedrepository▲#Executecodeowners-validatoragainstclonedrepository▲envREPOSITORY_PATH="./codeowners-samples"\▲envREPOSITORY_PATH="./codeowners-samples"\▲envREPOSITORY_PATH="./codeowners-samples"\▲envREPOSITORY_PATH="./codeowners-samples"\▲envREPOSITORY_PATH="./codeowners-samples"\EXPERIMENTAL_CHECKS="notowned"\EXPERIMENTAL_CHECKS="notowned"\GITHUB_ACCESS_TOKEN="${GH_TOKEN}"\GITHUB_ACCESS_TOKEN="${GH_TOKEN}"\GITHUB_ACCESS_TOKEN="${GH_TOKEN}"\GITHUB_ACCESS_TOKEN="${GH_TOKEN}"\OWNER_CHECKER_ORGANIZATION_NAME="gh-codeowners"\OWNER_CHECKER_ORGANIZATION_NAME="gh-codeowners"\OWNER_CHECKER_ORGANIZATION_NAME="gh-codeowners"\OWNER_CHECKER_ORGANIZATION_NAME="gh-codeowners"\OWNER_CHECKER_ORGANIZATION_NAME="gh-codeowners"\codeowners-validator[err] \ No newline at end of file +OWNER_CHECKER_ORGANIZATION_NAME="gh-codeowners"\▲▲#Downloadcodeowners-validatorbinary/binv0.2.0▲curl-sfLhttps://raw.githubusercontent.com/mszostok/codeowners-validator/main/install.sh|sh-s---b/usr/local/binv0.2.0mszostok/codeowners-validatorinfocheckingGitHubfortag'v0.2.0'mszostok/codeowners-validatorinfofoundversion:0.2.0forv0.2.0/Darwin/x86_64mszostok/codeowners-validatorinfoinstalled/usr/local/bin/codeowners-validator▲#CloneexamplerepositorywithsampleCODEOWNERS▲#CloneexamplerepositorywithsampleCODEOWNERS▲gitclonegit@github.com:gh-codeowners/codeowners-samples.gitCloninginto'codeowners-samples'...remote:Enumeratingobjects:8,done.remote:Countingobjects:100%(8/8),done.remote:Compressingobjects:100%(3/3),done.remote:Total8(delta0),reused8(delta0),pack-reused0Receivingobjects:100%(8/8),done.▲#Executecodeowners-validatoragainstclonedrepository▲#Executecodeowners-validatoragainstclonedrepositoryEXPERIMENTAL_CHECKS="notowned"\GITHUB_ACCESS_TOKEN="${GH_TOKEN}"\▲#Downloadcodeowners-validatorbinarycodeowners-validator▲envREPOSITORY_PATH="./codeowners-samples"\EXPERIMENTAL_CHECKS="notowned"\GITHUB_ACCESS_TOKEN="${GH_TOKEN}"\OWNER_CHECKER_ORGANIZATION_NAME="gh-codeowners"\codeowners-validator==>ExecutingFileExistChecker(1.240501ms)[err]line13:"/scripts/"doesnotmatchanyfilesinrepository==>ExecutingDuplicatedPatternChecker(1.820841ms)[err]Pattern"/some/awesome/dir"isdefined2timesinlines:*10:withowners:[@mszostok@owner-a]*11:withowners:[@octocat]==>Executing[Experimental]NotOwnedFileChecker(38.920431ms)CheckOK==>ExecutingValidOwnerChecker(1.238375347s)[err]line8:User"@mszostok"isnotamemberoftheorganization[err]line10:User"@owner-a"doesnothavegithubaccount[err]line11:User"@octocat"isnotamemberoftheorganization4check(s)executed,3failure(s)▲▲#Downloadcodeowners-validatorbinary▲#Downloadcodeowners-validatorbinary▲#Downloadcodeowners-validatorbinary▲curl-sfLhttps://raw.githubusercontent.com/mszostok/codeowners-validator/main/install.sh|sh-s---b/usr/local▲curl-sfLhttps://raw.githubusercontent.com/mszostok/codeowners-validator/main/install.sh|sh-s---b/usr/local▲curl-sfLhttps://raw.githubusercontent.com/mszostok/codeowners-validator/main/install.sh|sh-s---b/usr/local▲curl-sfLhttps://raw.githubusercontent.com/mszostok/codeowners-validator/main/install.sh|sh-s---b/usr/local▲curl-sfLhttps://raw.githubusercontent.com/mszostok/codeowners-validator/main/install.sh|sh-s---b/usr/local▲curl-sfLhttps://raw.githubusercontent.com/mszostok/codeowners-validator/main/install.sh|sh-s---b/usr/local▲curl-sfLhttps://raw.githubusercontent.com/mszostok/codeowners-validator/main/install.sh|sh-s---b/usr/local▲curl-sfLhttps://raw.githubusercontent.com/mszostok/codeowners-validator/main/install.sh|sh-s---b/usr/local▲curl-sfLhttps://raw.githubusercontent.com/mszostok/codeowners-validator/main/install.sh|sh-s---b/usr/local▲curl-sfLhttps://raw.githubusercontent.com/mszostok/codeowners-validator/main/install.sh|sh-s---b/usr/local▲curl-sfLhttps://raw.githubusercontent.com/mszostok/codeowners-validator/main/install.sh|sh-s---b/usr/local▲curl-sfLhttps://raw.githubusercontent.com/mszostok/codeowners-validator/main/install.sh|sh-s---b/usr/local▲curl-sfLhttps://raw.githubusercontent.com/mszostok/codeowners-validator/main/install.sh|sh-s---b/usr/local▲curl-sfLhttps://raw.githubusercontent.com/mszostok/codeowners-validator/main/install.sh|sh-s---b/usr/local▲curl-sfLhttps://raw.githubusercontent.com/mszostok/codeowners-validator/main/install.sh|sh-s---b/usr/local▲curl-sfLhttps://raw.githubusercontent.com/mszostok/codeowners-validator/main/install.sh|sh-s---b/usr/local▲curl-sfLhttps://raw.githubusercontent.com/mszostok/codeowners-validator/main/install.sh|sh-s---b/usr/local/binv0.2.0/binv0.2.0/binv0.2.0/binv0.2.0▲#CloneexamplerepositorywithsampleCODEOWNERS▲#CloneexamplerepositorywithsampleCODEOWNERS▲#CloneexamplerepositorywithsampleCODEOWNERS▲#CloneexamplerepositorywithsampleCODEOWNERS▲#CloneexamplerepositorywithsampleCODEOWNERS▲gitclonegit@github.com:gh-codeowners/codeowners-samples.git▲gitclonegit@github.com:gh-codeowners/codeowners-samples.git▲gitclonegit@github.com:gh-codeowners/codeowners-samples.git▲gitclonegit@github.com:gh-codeowners/codeowners-samples.git▲gitclonegit@github.com:gh-codeowners/codeowners-samples.git▲gitclonegit@github.com:gh-codeowners/codeowners-samples.git▲gitclonegit@github.com:gh-codeowners/codeowners-samples.git▲gitclonegit@github.com:gh-codeowners/codeowners-samples.git▲gitclonegit@github.com:gh-codeowners/codeowners-samples.git▲gitclonegit@github.com:gh-codeowners/codeowners-samples.gitReceivingobjects:12%(1/8)Receivingobjects:100%(8/8)▲#Executecodeowners-validatoragainstclonedrepository▲#Executecodeowners-validatoragainstclonedrepository▲#Executecodeowners-validatoragainstclonedrepository▲#Executecodeowners-validatoragainstclonedrepository▲#Executecodeowners-validatoragainstclonedrepository▲envREPOSITORY_PATH="./codeowners-samples"\▲envREPOSITORY_PATH="./codeowners-samples"\▲envREPOSITORY_PATH="./codeowners-samples"\▲envREPOSITORY_PATH="./codeowners-samples"\▲envREPOSITORY_PATH="./codeowners-samples"\EXPERIMENTAL_CHECKS="notowned"\EXPERIMENTAL_CHECKS="notowned"\GITHUB_ACCESS_TOKEN="${GH_TOKEN}"\GITHUB_ACCESS_TOKEN="${GH_TOKEN}"\GITHUB_ACCESS_TOKEN="${GH_TOKEN}"\GITHUB_ACCESS_TOKEN="${GH_TOKEN}"\OWNER_CHECKER_ORGANIZATION_NAME="gh-codeowners"\OWNER_CHECKER_ORGANIZATION_NAME="gh-codeowners"\OWNER_CHECKER_ORGANIZATION_NAME="gh-codeowners"\OWNER_CHECKER_ORGANIZATION_NAME="gh-codeowners"\OWNER_CHECKER_ORGANIZATION_NAME="gh-codeowners"\codeowners-validator[err] diff --git a/docs/gh-action.md b/docs/gh-action.md index 53e939c..a4572c5 100644 --- a/docs/gh-action.md +++ b/docs/gh-action.md @@ -12,7 +12,7 @@ The [Codeowners Validator](https://github.com/mszostok/codeowners-validator) is available as a GitHub Action.

- demo + demo