ci: skip most CI checks if title contains citest skip [citest_skip]

[richm]

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.

[sourcery-ai]

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Adds a conditional to most GitHub Actions CI jobs so they are skipped when a pull request title contains the marker "[citest_skip]", reducing unnecessary CI runs for documentation or CI-only changes.

Sequence diagram for conditional CI job execution based on PR title

sequenceDiagram
    actor Developer
    participant GitHub
    participant GitHubActions
    participant ansible_lint_job as ansible_lint
    participant codespell_job as codespell
    participant markdownlint_job as markdownlint

    Developer->>GitHub: Open or update pull_request
    GitHub-->>GitHubActions: pull_request event

    GitHubActions->>GitHubActions: Read github.event.pull_request.title

    alt title contains [citest_skip]
        GitHubActions-->>ansible_lint_job: Do not start job (if condition false)
        GitHubActions-->>codespell_job: Do not start job (if condition false)
        GitHubActions-->>markdownlint_job: Do not start job (if condition false)
    else title does not contain [citest_skip]
        GitHubActions->>ansible_lint_job: Run ansible_lint job
        GitHubActions->>codespell_job: Run codespell job
        GitHubActions->>markdownlint_job: Run markdownlint job
    end

Loading

Flow diagram for GitHub Actions CI skipping logic based on PR title

flowchart TD
    A["pull_request event received"] --> B["Read github.event.pull_request.title"]
    B --> C{"Title contains [citest_skip]?"}
    C -- Yes --> D["Set job condition to false<br/>ansible_lint, ansible_managed_var_comment,<br/>codeql analyze, codespell, markdownlint, woke<br/>jobs are skipped"]
    C -- No --> E["Job condition true<br/>Run ansible_lint job"]
    C -- No --> F["Run ansible_managed_var_comment job"]
    C -- No --> G["Run codeql analyze job"]
    C -- No --> H["Run codespell job"]
    C -- No --> I["Run markdownlint job"]
    C -- No --> J["Run woke job"]
    D --> K["CI completes with selected jobs skipped"]
    E --> K
    F --> K
    G --> K
    H --> K
    I --> K
    J --> K

Loading

File-Level Changes

Change	Details	Files
Conditionally skip most CI workflows when the PR title contains the marker string	Add an if condition to each CI job to negate contains(github.event.pull_request.title, '[citest_skip]') so those jobs do not run when the marker is present Apply this conditional to linting, testing, CodeQL, spell-check, markdownlint, qemu integration, README conversion, and inclusive-language workflows	.github/workflows/ansible-lint.yml .github/workflows/ansible-managed-var-comment.yml .github/workflows/ansible-test.yml .github/workflows/codeql.yml .github/workflows/codespell.yml .github/workflows/markdownlint.yml .github/workflows/python-unit-test.yml .github/workflows/qemu-kvm-integration-tests.yml .github/workflows/test_converting_readme.yml .github/workflows/woke.yml

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey - I've reviewed your changes and they look great!

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}