Skip to content

Conversation

@lokielse
Copy link
Contributor

Description

This PR adds auto-generation warning comments to all RBAC YAML files and CRD YAML files to prevent manual edits. These files are generated by controller-gen and should not be manually modified.

Changes:

  • Added warning comments to all RBAC YAML files in deployments/kai-scheduler/templates/rbac/
  • Added warning comments to all CRD YAML files in deployments/kai-scheduler/crds/
  • Updated the YAML boilerplate template in hack/boilerplate.yaml.txt

The warning comment includes:

# DO NOT EDIT - This file is auto-generated by controller-gen
# To modify RBAC permissions, edit the +kubebuilder:rbac markers in the source code
# and run 'make manifests' to regenerate this file.

This helps prevent accidental manual modifications to auto-generated files and directs contributors to the proper workflow for making changes.

Related Issues

N/A

Checklist

Note: Ensure your PR title follows the Conventional Commits format (e.g., feat(scheduler): add new feature)

  • Self-reviewed
  • Added/updated tests (if needed)
  • Updated CHANGELOG.md (if needed)
  • Updated documentation (if needed)

Breaking Changes

None

Additional Notes

This is a documentation-only change that adds helpful comments to auto-generated YAML files. No functional changes are made to the RBAC permissions or CRD definitions themselves.

The changes affect the following files:

  • 5 CRD definition files
  • 10 RBAC template files
  • 1 boilerplate template file

Total: 16 files updated with warning comments

Copy link
Collaborator

@enoodle enoodle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, great idea. One file shouldn't be included:

@enoodle enoodle enabled auto-merge (squash) November 15, 2025 19:42
@enoodle enoodle merged commit 2297956 into NVIDIA:main Nov 15, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants