Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update mszostok/codeowners-validator action to v0.7.4 #123

Merged
merged 1 commit into from
Jun 16, 2022

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Feb 14, 2022

Mend Renovate

This PR contains the following updates:

Package Type Update Change
mszostok/codeowners-validator action minor v0.6.0 -> v0.7.4

Release Notes

mszostok/codeowners-validator

v0.7.4

Compare Source

🎉 GitHub Codeowners Validator 0.7.4 is now available!

Highlights

✨ New functionality

First entry
 /build/logs/ @​octocat
Shadows - reported as error
 * @​s1
 /b*/logs @​s5
OK
 /b*/other @​o1
 /script/* @​o2
 ```

🔧 Bug Fixes

Changelog

v0.7.3

Compare Source

🎉 GitHub Codeowners Validator 0.7.3 is now available!

Highlights

✨ New functionality

  • not-owned-checker: Add git-ls-tree implementation with subdirectory support (#​141) (@​jeremycohen)
    Now you can specify against which subdirectories the not-owned check should be executed. To configure that, use the NOT_OWNED_CHECKER_SUBDIRECTORIES environment variable. In the default mode, it works as previously, where all files are checked.
  • Add GitHub token validation to get rid of misleading error checks (#​143)

🔧 Bug Fixes

  • Fix scope and internal error handling (#​145) (@​mszostok)
    The previous release informs the user about the internal error, but the exit code was not properly propagated. Now, besides the error message, the exit code is also set.
Changelog

v0.7.2

Compare Source

🎉 GitHub Codeowners Validator 0.7.2 is now available!

Highlights

🔧 Bug Fixes

✨ New checks

  • Add a flag to only allow teams as owners (#​127) (@​seveas)
    Now you can enable more strict rule and specify that only teams are allowed as owners of files.

🛡️ Security

Installation

See the Installation section for more installation options.

Docker images

ghcr.io:

  • docker pull ghcr.io/mszostok/codeowners-validator:stable
  • docker pull ghcr.io/mszostok/codeowners-validator:v0
  • docker pull ghcr.io/mszostok/codeowners-validator:v0.7
  • docker pull ghcr.io/mszostok/codeowners-validator:v0.7.2
Changelog 🚀

v0.7.1

Compare Source

🔧 Bug fix release for 0.7.1 is now available!

Issue

Reports Team does not belong to organization error even if team is assigned to a proper GitHub organization. (https://github.com/mszostok/codeowners-validator/issues/121)

Root cause

This was a side effect of https://github.com/mszostok/codeowners-validator/pull/78#issuecomment-941445181 where not only team was normalized. Unfortunately, it was not detected by the integration test, as I used only the gh-codeowners organization. As you can see, it's all lower-case.

To reproduce the problem, I created a new organization GitHubCODEOWNERS and executed the v0.7 against it and ran into the same problem: https://github.com/GitHubCODEOWNERS/codeowners-samples/runs/5173200010?check_suite_focus=true

I tested that further to check whether GitHub also is case-insensitive for Organization names:

Corrective and Preventative Measures

To fix that problem, I created this PR: https://github.com/mszostok/codeowners-validator/pull/122 and tested also against a newly created organization: https://github.com/GitHubCODEOWNERS/codeowners-samples/runs/5173279973?check_suite_focus=true

I also added new integration tests against new GitHubCODEOWNERS organization to ensure no regression in the future.

Additional Corrective and Preventative Measures

In this case it's a bit of revers engineering as I don't have access to GitHub code which is responsible for assigning owners. As a result, I will need to create yet another e2e test that will be executed periodically to:

  • Create a sample PR against files where @GiTHubCodeOwners/A-TeAm is specified and check whether GitHub is still case-insensitive and assigns @GitHubCodeowners/a-team properly.

In this way, I will be notified when GitHub will change its behavior and I will be able to release a new version that will match a changed functionality.

Changelog

Please see: https://github.com/mszostok/codeowners-validator/releases/tag/v0.7.0

v0.7.0

Compare Source

🎉 GitHub Codeowners Validator 0.7.0 is now available!

Highlights

🔧 Bug Fixes

  • Normalize team name before comparison (#​78) (@​mszostok)
    GitHub is case-insensitive when assigning owners for a review. To match this approach now owners are normalized before checking if they exist under a given GitHub organization.

  • Allow unowned patterns by default with an option to change it (#​113) (@​mszostok)
    GitHub allows you to define a pattern and left its owners empty. For example:

    /apps/ @​octocat
    /apps/github 
    

    In version 0.6 this was reported as error (Missing owner, at least one owner is required).
    In this release, this check was moved under owner checker and made optional. As a result, validator may work in a picky mode when needed, see new option:

    Name Default Description
    OWNER_CHECKER_ALLOW_UNOWNED_PATTERNS true Specifies whether CODEOWNERS may have unowned files. For example:

    /infra/oncall-rotator/ @​sre-team
    /infra/oncall-rotator/oncall-config.yml

    The /infra/oncall-rotator/oncall-config.yml file is not owned by anyone.
    To enable strict mode on GitHub Action specify:
          - name: GitHub CODEOWNERS Validator
            uses: mszostok/codeowners-validator@v0.7.0
            with:
              owner_checker_allow_unowned_patterns: "false"

    Additionally, it is now reported as warning not error:

    ==> Executing Valid Owner Checker (1.2s)
        [war] line 23: Missing owner, at least one owner is required
    
  • Fix spelling of brand GitHub (#​106) (@​jsoref)

  • 0e709b4: Changed belongs to belong in error message, add integration tests(#​108) (@​kyleellman)

✨ New checks

  • Enforce only one CODEOWNERS file (#​100) (@​athtran)
    In v0.7 an error is reported when more than one CODEOWNERS file is detected.

📖 Docs

🛡️ Security

Installation

See the Installation section for more installation options.

Docker images

ghcr.io:

  • docker pull ghcr.io/mszostok/codeowners-validator:stable
  • docker pull ghcr.io/mszostok/codeowners-validator:v0
  • docker pull ghcr.io/mszostok/codeowners-validator:v0.7
  • docker pull ghcr.io/mszostok/codeowners-validator:v0.7.0

Docker Hub:

NOTE: Pushing to docker Hub will be deprecated and removed soon.

  • docker pull mszostok/codeowners-validator:latest
  • docker pull mszostok/codeowners-validator:v0.7.0
  • docker pull mszostok/codeowners-validator:v0.7
Changelog 🚀

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, click this checkbox.

This PR has been generated by Mend Renovate. View repository job log here.

@renovate renovate bot requested a review from remal as a code owner February 14, 2022 12:56
@renovate renovate bot assigned remal Feb 14, 2022
@trafico-bot trafico-bot bot added the ready-for-review Pull Request is not reviewed yet label Feb 14, 2022
@renovate renovate bot force-pushed the renovate/mszostok-codeowners-validator-0.x branch from b53b678 to 4ce7b8b Compare February 14, 2022 18:40
@renovate renovate bot force-pushed the renovate/mszostok-codeowners-validator-0.x branch from 4ce7b8b to 4f2b786 Compare April 6, 2022 20:07
@renovate renovate bot changed the title Update mszostok/codeowners-validator action to v0.7.1 Update mszostok/codeowners-validator action to v0.7.2 Apr 6, 2022
@renovate renovate bot force-pushed the renovate/mszostok-codeowners-validator-0.x branch from 4f2b786 to 175a201 Compare April 12, 2022 23:01
@renovate renovate bot changed the title Update mszostok/codeowners-validator action to v0.7.2 Update mszostok/codeowners-validator action to v0.7.3 Apr 13, 2022
@renovate renovate bot force-pushed the renovate/mszostok-codeowners-validator-0.x branch from 175a201 to 8d27abe Compare April 16, 2022 13:52
@renovate renovate bot changed the title Update mszostok/codeowners-validator action to v0.7.3 Update mszostok/codeowners-validator action to v0.7.4 Apr 16, 2022
@remal remal merged commit ec4c172 into main Jun 16, 2022
@remal remal deleted the renovate/mszostok-codeowners-validator-0.x branch June 16, 2022 02:13
@trafico-bot trafico-bot bot removed the ready-for-review Pull Request is not reviewed yet label Jun 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

2 participants