ci: skip most CI checks if title contains citest skip [citest_skip]#309
Merged
ci: skip most CI checks if title contains citest skip [citest_skip]#309
Conversation
Reviewer's guide (collapsed on small PRs)Reviewer's GuideThis PR updates all major GitHub Actions workflows to conditionally skip running jobs when a pull request title includes the marker "[citest_skip]", reducing unnecessary CI load for CI/docs-only changes. Flow diagram for CI job execution decision using citest_skipflowchart TD
PR[PR_opened_or_updated]
Title[Read_PR_title]
CheckTitle{"Does_title_contain_[citest_skip]?"}
PR --> Title --> CheckTitle
CheckTitle -- Yes --> Skip[Skip_all_citest_skip_guarded_jobs]
CheckTitle -- No --> Run[Run_all_standard_CI_jobs]
subgraph Guarded_jobs_examples
G1[ansible_lint_job]
G2[ansible_managed_var_comment_job]
G3[codeql_analyze_job]
G4[codespell_job]
G5[markdownlint_job]
G6[woke_job]
end
Run --> G1
Run --> G2
Run --> G3
Run --> G4
Run --> G5
Run --> G6
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 found 1 issue, and left some high level feedback:
- In workflows that can be triggered by non–pull_request events (e.g., codeql.yml with push and schedule), referencing github.event.pull_request.title will fail; guard the condition with an event check (e.g.,
if: github.event_name != 'pull_request' || !contains(github.event.pull_request.title, '[citest_skip]')). - Consider centralizing the
[citest_skip]condition via a reusable workflow or a shared expression pattern to avoid duplicating the sameiflogic across many jobs and workflows.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- In workflows that can be triggered by non–pull_request events (e.g., codeql.yml with push and schedule), referencing github.event.pull_request.title will fail; guard the condition with an event check (e.g., `if: github.event_name != 'pull_request' || !contains(github.event.pull_request.title, '[citest_skip]')`).
- Consider centralizing the `[citest_skip]` condition via a reusable workflow or a shared expression pattern to avoid duplicating the same `if` logic across many jobs and workflows.
## Individual Comments
### Comment 1
<location> `.github/workflows/codeql.yml:17` </location>
<code_context>
contents: read
jobs:
ansible_lint:
+ if: "!contains(github.event.pull_request.title, '[citest_skip]')"
runs-on: ubuntu-latest
steps:
</code_context>
<issue_to_address>
**issue (bug_risk):** Guard against non-pull_request events to avoid potential evaluation errors on scheduled runs.
Because this workflow also runs on `schedule`, `github.event.pull_request` is undefined for those executions. Using it directly in `contains` can cause unintended skips or even workflow failures. Please guard on the event type or the null case, for example:
```yaml
if: github.event_name != 'pull_request' || !contains(github.event.pull_request.title, '[citest_skip]')
```
or:
```yaml
if: !github.event.pull_request || !contains(github.event.pull_request.title, '[citest_skip]')
```
</issue_to_address>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>
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.