generated from linux-system-roles/template
-
Notifications
You must be signed in to change notification settings - Fork 11
ci: skip most CI checks if title contains citest skip [citest_skip] #164
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
Open
richm
wants to merge
2
commits into
main
Choose a base branch
from
citest_skip
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
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 GuideThis PR updates multiple GitHub Actions workflows so that their jobs are skipped when a pull request title contains the marker "[citest_skip]", allowing CI-heavy checks to be bypassed for certain maintenance PRs. Sequence diagram for conditional CI job execution based on PR titlesequenceDiagram
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: pull_request_event
GitHub-->>Workflow_codespell: pull_request_event
GitHub-->>Workflow_markdownlint: pull_request_event
GitHub-->>Workflow_woke: pull_request_event
alt Title_contains_citest_skip
Workflow_ansible_lint-->>Workflow_ansible_lint: if !contains(title,'[citest_skip]') is false
Workflow_codespell-->>Workflow_codespell: Job_skipped
Workflow_markdownlint-->>Workflow_markdownlint: Job_skipped
Workflow_woke-->>Workflow_woke: Job_skipped
else Title_does_not_contain_citest_skip
Workflow_ansible_lint->>Workflow_ansible_lint: Run_ansible_lint_steps
Workflow_codespell->>Workflow_codespell: Run_codespell_steps
Workflow_markdownlint->>Workflow_markdownlint: Run_markdownlint_steps
Workflow_woke->>Workflow_woke: Run_woke_steps
end
GitHub-->>Developer: Report_status_with_jobs_run_or_skipped
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:
- These workflows assume
github.event.pull_requestis always present; if any of them are ever triggered by non-pull_requestevents (e.g.,push), consider guarding the condition withgithub.event_name == 'pull_request'orgithub.event.pull_request && !contains(...)to avoid null access issues. - Using the PR title as the control surface for skipping CI can be brittle (e.g., title edits, typos); you might consider using a dedicated label (checked via
github.event.pull_request.labels) instead, which is easier to manage and script.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- These workflows assume `github.event.pull_request` is always present; if any of them are ever triggered by non-`pull_request` events (e.g., `push`), consider guarding the condition with `github.event_name == 'pull_request'` or `github.event.pull_request && !contains(...)` to avoid null access issues.
- Using the PR title as the control surface for skipping CI can be brittle (e.g., title edits, typos); you might consider using a dedicated label (checked via `github.event.pull_request.labels`) instead, which is easier to manage and script.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.