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.

Sign up for GitHub

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

Jump to bottom

Update mszostok/codeowners-validator action to v0.7.1 #35

Merged
merged 2 commits into from
Feb 21, 2022
Merged

Update mszostok/codeowners-validator action to v0.7.1 #35

merged 2 commits into from
Feb 21, 2022

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Feb 12, 2022 •
edited
Loading

WhiteSource Renovate

This PR contains the following updates:

Package Type Update Change
mszostok/codeowners-validator action minor v0.5.0 -> v0.7.1

Release Notes

mszostok/codeowners-validator

v0.7.1

Compare Source

🔧 Bug fix release for 0.7.0 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/[email protected]
        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 🚀

v0.6.0

Compare Source

🚨GitHub Codeowners Validator 0.6.0 is now available!

Highlights

  • ✨ Add validation for checking if team has a proper permission
    Due to the new permission validation step in Owners Checker, this check takes a little more time.

  • 🐛 Fix bug in Owners Checker. Now Owners Checker supports child teams with inherited repo perms.

  • ⚠️ Error message was changed in Owners Checker.

From
[err] line 15: Team "avengers" does not have permissions associated with the repository "codeowners-samples".
To
[err] line 15: Team "avengers" does not exist in organization "gh-codeowners" or has no permissions associated with the repository.
```
Installation

To install the codeowners-validator, run:

##### Install codeowners-validator in /usr/local/bin in version 0.6.0
curl -sfL https://raw.githubusercontent.com/mszostok/codeowners-validator/master/install.sh| sh -s -- -b /usr/local/bin v0.6.0

See the Installation section for more installation options.

Docker images
  • docker pull mszostok/codeowners-validator:latest
  • docker pull mszostok/codeowners-validator:v0.6.0
  • docker pull mszostok/codeowners-validator:v0.6
Changelog 🚀

8fafb0b Adjust docs and GitHub action for v0.6.0 release
2f6e3bb Fix badly worded error (#​64)
5ed7b98 Adjust integration test after changing error message
204640e address comments from PR #​62
9224144 Add permissions check to valid_owner
cde24ed Add a twitter badge
e5e11b0 rename test to comply with golang.org/x/mod/module.CheckFilePath (#​60)

Contributors

Thanks again to everyone who contributed to this release! ✨

Users whose commits are in this release:

v0.5.1

Compare Source

Changelog

d6bdfac Add CONTRIBUTING.md and development.md (#​56)
4f46df1 Add configurability for the list of ignored owners (#​55)
085f270 Adjust docs and GitHub action for v0.5.1 release
97fb795 Ignore ghost user (#​53)
0b6c2ef Update info about new checker (#​51)

Docker images
  • docker pull mszostok/codeowners-validator:latest
  • docker pull mszostok/codeowners-validator:v0.5.1
  • docker pull mszostok/codeowners-validator:v0.5

Configuration

📅 Schedule: At any time (no schedule defined).

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

♻ Rebasing: Renovate will not automatically rebase this PR, because other commits have been found.

🔕 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 WhiteSource Renovate. View repository job log here.

@renovate renovate bot requested review from a team as code owners February 12, 2022 23:16
@renovate renovate bot requested review from dylanbannon and SweetOps February 12, 2022 23:16
@renovate renovate bot force-pushed the renovate/mszostok-codeowners-validator-0.x branch from 94965ca to f606575 Compare February 13, 2022 12:20
@renovate renovate bot changed the title Update mszostok/codeowners-validator action to v0.7.0 Update mszostok/codeowners-validator action to v0.7.1 Feb 13, 2022
@Nuru Nuru added the no-release Do not create a new release (wait for additional code changes) label Feb 21, 2022
@Nuru Nuru merged commit c9164d4 into master Feb 21, 2022
@Nuru Nuru deleted the renovate/mszostok-codeowners-validator-0.x branch February 21, 2022 05:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Nuru Nuru Nuru approved these changes

@dylanbannon dylanbannon Awaiting requested review from dylanbannon dylanbannon is a code owner automatically assigned from cloudposse/contributors

@SweetOps SweetOps Awaiting requested review from SweetOps SweetOps is a code owner automatically assigned from cloudposse/contributors

Assignees
No one assigned
Labels
no-release Do not create a new release (wait for additional code changes)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Nuru @renovate-bot