Skip to content
This repository has been archived by the owner on Mar 2, 2022. It is now read-only.

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

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

wants to merge 1 commit into from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Feb 14, 2022

WhiteSource Renovate

This PR contains the following updates:

Package Type Update Change
mszostok/codeowners-validator action minor v0.6.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 🚀

Configuration

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

@renovate renovate bot requested a review from remal as a code owner February 14, 2022 14:47
@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 41d7b67 to b08af85 Compare February 14, 2022 18:24
@renovate renovate bot force-pushed the renovate/mszostok-codeowners-validator-0.x branch 4 times, most recently from 1bdaa60 to cf62353 Compare March 2, 2022 03:38
@sonarcloud
Copy link

sonarcloud bot commented Mar 2, 2022

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@renovate renovate bot force-pushed the renovate/mszostok-codeowners-validator-0.x branch from cf62353 to 5fc9747 Compare March 2, 2022 03:52
@renovate renovate bot force-pushed the renovate/mszostok-codeowners-validator-0.x branch from 5fc9747 to 414c828 Compare March 2, 2022 06:36
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@remal remal Awaiting requested review from remal remal is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

@remal remal

Labels
dependencies Pull requests that update a dependency file dependencies-ci dependencies-ci-minor dependencies-minor ready-for-review Pull Request is not reviewed yet
Projects
None yet
Milestone
No milestone
Development

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