ci: skip most CI checks if title contains citest skip [citest_skip]#318
Merged
ci: skip most CI checks if title contains citest skip [citest_skip]#318
Conversation
Reviewer's guide (collapsed on small PRs)Reviewer's GuideAdds a conditional guard to most GitHub Actions CI jobs so they are skipped when the pull request title contains the marker "[citest_skip]" to avoid unnecessary CI runs for certain PRs. Sequence diagram for GitHub Actions job evaluation with citest_skipsequenceDiagram
actor Developer
participant GitHub
participant Workflow_ansible_lint
Developer->>GitHub: Open_or_update_PR_with_title
GitHub->>Workflow_ansible_lint: Evaluate_job_trigger
alt Title_does_not_contain_citest_skip
Workflow_ansible_lint-->>GitHub: Condition_true_run_job
GitHub->>Workflow_ansible_lint: Start_ansible_lint_job
else Title_contains_citest_skip
Workflow_ansible_lint-->>GitHub: Condition_false_skip_job
GitHub--xWorkflow_ansible_lint: Do_not_start_job
end
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- For workflows that are triggered by events other than
pull_request(e.g., the scheduled CodeQL run),github.event.pull_requestmay be undefined, so theif: "!contains(github.event.pull_request.title, '[citest_skip]')"check can fail; consider guarding with the event type or using a default string, e.g.if: github.event_name != 'pull_request' || !contains(github.event.pull_request.title || '', '[citest_skip]'). - If the intent is to skip CI only for PR-triggered runs while keeping scheduled or push-based checks always on, you may want to restrict the skip logic to
pull_requestworkflows (or addgithub.event_name == 'pull_request'to the condition) so that non-PR workflows remain unaffected.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- For workflows that are triggered by events other than `pull_request` (e.g., the scheduled CodeQL run), `github.event.pull_request` may be undefined, so the `if: "!contains(github.event.pull_request.title, '[citest_skip]')"` check can fail; consider guarding with the event type or using a default string, e.g. `if: github.event_name != 'pull_request' || !contains(github.event.pull_request.title || '', '[citest_skip]')`.
- If the intent is to skip CI only for PR-triggered runs while keeping scheduled or push-based checks always on, you may want to restrict the skip logic to `pull_request` workflows (or add `github.event_name == 'pull_request'` to the condition) so that non-PR workflows remain unaffected.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 <[email protected]>
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 <[email protected]>
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
1 participant
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.