-
Notifications
You must be signed in to change notification settings - Fork 20
ci: skip most CI checks if title contains citest skip [citest_skip] #192
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
Conversation
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
Reviewer's guide (collapsed on small PRs)Reviewer's GuideConfigures multiple GitHub Actions CI jobs to be conditionally skipped when a pull request title contains the marker '[citest_skip]', allowing CI to be bypassed for certain PRs such as CI or docs-only changes. Sequence diagram for conditional CI job execution based on citest_skipsequenceDiagram
actor Developer
participant GitHub
participant Workflow_ansible_lint
participant Workflow_codespell
participant Workflow_markdownlint
participant Workflow_woke
Developer->>GitHub: Open pull_request with title
GitHub-->>Workflow_ansible_lint: Trigger ansible_lint on pull_request
GitHub-->>Workflow_codespell: Trigger codespell on pull_request
GitHub-->>Workflow_markdownlint: Trigger markdownlint on pull_request
GitHub-->>Workflow_woke: Trigger woke on pull_request
alt Title contains [citest_skip]
Workflow_ansible_lint-->>GitHub: Job skipped by if condition
Workflow_codespell-->>GitHub: Job skipped by if condition
Workflow_markdownlint-->>GitHub: Job skipped by if condition
Workflow_woke-->>GitHub: Job skipped by if condition
else Title does not contain [citest_skip]
Workflow_ansible_lint->>Workflow_ansible_lint: Run CI steps
Workflow_codespell->>Workflow_codespell: Run CI steps
Workflow_markdownlint->>Workflow_markdownlint: Run CI steps
Workflow_woke->>Workflow_woke: Run CI steps
end
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey - I've left some high level feedback:
- If any of these workflows are also triggered by events other than
pull_request(e.g.push), consider guarding the condition with the event type (e.g.if: github.event_name != 'pull_request' || !contains(github.event.pull_request.title, '[citest_skip]')) to avoid referencing a non-existentpull_requestpayload. - Since the
[citest_skip]marker is now used across multiple workflows, you may want to define a single reusable expression (e.g. via a reusable workflow or sharedenv/jobs.<job>.ifpattern) to keep this logic consistent and easier to update later.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- If any of these workflows are also triggered by events other than `pull_request` (e.g. `push`), consider guarding the condition with the event type (e.g. `if: github.event_name != 'pull_request' || !contains(github.event.pull_request.title, '[citest_skip]')`) to avoid referencing a non-existent `pull_request` payload.
- Since the `[citest_skip]` marker is now used across multiple workflows, you may want to define a single reusable expression (e.g. via a reusable workflow or shared `env`/`jobs.<job>.if` pattern) to keep this logic consistent and easier to update later.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
When we submit a PR for a CI update or docs, we do not want to start CI checking for ansible-lint, qemu, etc. When we are doing CI updates to 30 or more roles, this fires off a lot of unnecessary tests, which sometimes causes the linux-system-roles org in github to be throttled. When submitting a PR that can skip ci, use "[citest_skip]" in the PR title. Signed-off-by: Rich Megginson <rmeggins@redhat.com>
When we submit a PR for a CI update or docs, we do not want to start CI checking for ansible-lint, qemu, etc. When we are doing CI updates to 30 or more roles, this fires off a lot of unnecessary tests, which sometimes causes the linux-system-roles org in github to be throttled. When submitting a PR that can skip ci, use "[citest_skip]" in the PR title. Signed-off-by: Rich Megginson <rmeggins@redhat.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
When we submit a PR for a CI update or docs, we do not want to start CI checking
for ansible-lint, qemu, etc. When we are doing CI updates to 30 or more
roles, this fires off a lot of unnecessary tests, which sometimes causes the
linux-system-roles org in github to be throttled.
When submitting a PR that can skip ci, use "[citest_skip]" in the PR title.