ci(crdify): change enforcement to warn for description modifications#1472
Merged
Conversation
Reviewer's guide (collapsed on small PRs)Reviewer's GuideUpdates the CI linter workflow to use crdify v0.5.0 with a shared configuration that relaxes description validation to warnings when comparing CRDs between base and head commits. Flow diagram for updated crdify usage in linter workflowflowchart TD
Start[["PR opened or updated"]] --> Checkout["Checkout repository"]
Checkout --> SetupGo["Set up Go from go.mod"]
SetupGo --> InstallCrdify["go install sigs.k8s.io/crdify@v0.5.0"]
InstallCrdify --> LoadConfig["Load crdify.yaml (description enforcement Warn)"]
LoadConfig --> CompareCTlog["crdify --config=crdify.yaml compare CTlog CRD (base vs head)"]
CompareCTlog --> CompareFulcio["crdify --config=crdify.yaml compare Fulcio CRD (base vs head)"]
CompareFulcio --> CompareRekor["crdify --config=crdify.yaml compare Rekor CRD (base vs head)"]
CompareRekor --> CompareTSA["crdify --config=crdify.yaml compare TSA CRD (base vs head)"]
CompareTSA --> CompareTrillian["crdify --config=crdify.yaml compare Trillian CRD (base vs head)"]
CompareTrillian --> CompareTUF["crdify --config=crdify.yaml compare TUF CRD (base vs head)"]
CompareTUF --> CompareSecuresign["crdify --config=crdify.yaml compare Securesign CRD (base vs head)"]
CompareSecuresign --> Results["crdify reports diffs; description-only changes produce warnings"]
Results --> CIOutcome["Linter job outcome (fails on strict violations, passes with description warnings)"]
CIOutcome --> End[["PR CI status updated"]]
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
PR Compliance Guide 🔍Below is a summary of compliance checks for this PR:
Compliance status legend🟢 - Fully Compliant🟡 - Partial Compliant 🔴 - Not Compliant ⚪ - Requires Further Human Verification 🏷️ - Compliance label |
||||||||||||||||||||||||
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey there - I've reviewed your changes - here's some feedback:
- The workflow repeats nearly identical crdify steps for each CRD; consider using a job matrix or a shell loop to reduce duplication and make it easier to add or remove CRDs in the future.
- Since crdify is now configured via crdify.yaml, you might want to add a brief inline comment in the workflow pointing to the config file so future updates to validations are easier to discover from the CI definition.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The workflow repeats nearly identical crdify steps for each CRD; consider using a job matrix or a shell loop to reduce duplication and make it easier to add or remove CRDs in the future.
- Since crdify is now configured via crdify.yaml, you might want to add a brief inline comment in the workflow pointing to the config file so future updates to validations are easier to discover from the CI definition.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
PR Code Suggestions ✨Explore these optional code suggestions:
|
|||||||||
Contributor
Signed-off-by: Tomas Turek <tturek@redhat.com>
osmman
force-pushed
the
tturek/crdify-config
branch
from
2bfcd12 to
a7187f0
Compare
Contributor
|
Not impressed |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Type
Enhancement
Description
Upgrade crdify tool from v0.4.0 to v0.5.0
Add crdify configuration file with warning enforcement
Apply configuration to all CRD comparison commands
Change description validation from error to warning level
Diagram Walkthrough
File Walkthrough
linter.yml
Update crdify version and add config flag.github/workflows/linter.yml
--config=crdify.yamlflag to all eight CRD comparison commandscrdify.yaml
Add crdify configuration with warning enforcementcrdify.yaml