Skip to content

chore(check): verify that UPGRADE.md has changed after Role change #13396

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

Merged
merged 2 commits into from
Apr 16, 2025

Conversation

lukidzi
Copy link
Contributor

@lukidzi lukidzi commented Apr 14, 2025

Motivation

We want to avoid frequent changes to RBAC and ensure that users who upgrade and have RBAC creation disabled will see a note about it in the UPGRADE.md.

Implementation information

I've added a check/rbac command to check for changed files, specifically looking for Role, RoleBinding, ClusterRole, or ClusterRoleBinding. It also verifies that UPGRADE.md has been updated. If any RBAC-related changes are detected, the command will fail with a message.

Supporting documentation

Fix: #13386

@lukidzi lukidzi requested a review from a team as a code owner April 14, 2025 15:26
@lukidzi lukidzi requested review from slonka and bartsmykla April 14, 2025 15:26
Copy link
Contributor

Reviewer Checklist

🔍 Each of these sections need to be checked by the reviewer of the PR 🔍:
If something doesn't apply please check the box and add a justification if the reason is non obvious.

  • Is the PR title satisfactory? Is this part of a larger feature and should be grouped using > Changelog?
  • PR description is clear and complete. It Links to relevant issue as well as docs and UI issues
  • This will not break child repos: it doesn't hardcode values (.e.g "kumahq" as an image registry)
  • IPv6 is taken into account (.e.g: no string concatenation of host port)
  • Tests (Unit test, E2E tests, manual test on universal and k8s)
    • Don't forget ci/ labels to run additional/fewer tests
  • Does this contain a change that needs to be notified to users? In this case, UPGRADE.md should be updated.
  • Does it need to be backported according to the backporting policy? (this GH action will add "backport" label based on these file globs, if you want to prevent it from adding the "backport" label use no-backport-autolabel label)

@lukidzi lukidzi added the ci/skip-test PR: Don't run unit and e2e tests (maybe this is just a doc change) label Apr 14, 2025
Signed-off-by: Lukasz Dziedziak <[email protected]>
@lukidzi lukidzi requested a review from slonka April 15, 2025 12:17
@lukidzi lukidzi merged commit bbdf6f6 into kumahq:master Apr 16, 2025
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci/skip-test PR: Don't run unit and e2e tests (maybe this is just a doc change)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a message on change of ClusterRole
3 participants