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 multiple GitHub Actions workflows so that most CI jobs are skipped when a pull request title contains the marker string "[citest_skip]".

Sequence diagram for conditional CI job execution based on PR title marker

sequenceDiagram
  actor Developer
  participant GitHub
  participant WorkflowDispatcher
  participant Job_ansible_lint as Job_ansible_lint
  participant Job_codespell as Job_codespell
  participant Job_markdownlint as Job_markdownlint
  participant Job_shellcheck as Job_shellcheck
  participant Job_woke as Job_woke

  Developer->>GitHub: Create_or_update_pull_request(title)
  GitHub->>WorkflowDispatcher: pull_request_event

  note over WorkflowDispatcher: Evaluate condition
  WorkflowDispatcher->>WorkflowDispatcher: contains(github.event.pull_request.title, [citest_skip])

  alt Title_contains_citest_skip
    WorkflowDispatcher--xJob_ansible_lint: Do_not_start_job
    WorkflowDispatcher--xJob_codespell: Do_not_start_job
    WorkflowDispatcher--xJob_markdownlint: Do_not_start_job
    WorkflowDispatcher--xJob_shellcheck: Do_not_start_job
    WorkflowDispatcher--xJob_woke: Do_not_start_job
  else Title_does_not_contain_citest_skip
    WorkflowDispatcher->>Job_ansible_lint: Start_job_if_expression_true
    WorkflowDispatcher->>Job_codespell: Start_job_if_expression_true
    WorkflowDispatcher->>Job_markdownlint: Start_job_if_expression_true
    WorkflowDispatcher->>Job_shellcheck: Start_job_if_expression_true
    WorkflowDispatcher->>Job_woke: Start_job_if_expression_true
  end

Loading

Flow diagram for CI job execution decision based on PR title

flowchart TD
  A["Pull request opened or updated"] --> B["Read pull_request.title"]
  B --> C{"Does title contain [citest_skip]?"}

  C -- Yes --> D["Evaluate job if expression
  !contains(title, [citest_skip]) as false"]
  D --> E["Do not start CI jobs
  ansible_lint, ansible_managed_var_comment,
  codespell, markdownlint, shellcheck, woke"]

  C -- No --> F["Evaluate job if expression
  !contains(title, [citest_skip]) as true"]
  F --> G["Start all configured CI jobs"]

Loading

File-Level Changes

Change	Details	Files
Conditionally skip CI jobs when PR title includes the citest_skip marker.	Add an if condition to the ansible-lint job to skip when the pull request title contains "[citest_skip]" Add an if condition to the ansible-managed-var-comment job to skip when the pull request title contains "[citest_skip]" Add an if condition to the ansible-test job to skip when the pull request title contains "[citest_skip]" Add an if condition to the codespell job to skip when the pull request title contains "[citest_skip]" Add an if condition to the markdownlint job to skip when the pull request title contains "[citest_skip]" Add an if condition to the qemu-kvm integration tests job to skip when the pull request title contains "[citest_skip]" Add an if condition to the shellcheck job to skip when the pull request title contains "[citest_skip]" Add an if condition to the test_converting_readme job to skip when the pull request title contains "[citest_skip]" Add an if condition to the woke job to skip when the pull request title contains "[citest_skip]"	.github/workflows/ansible-lint.yml .github/workflows/ansible-managed-var-comment.yml .github/workflows/ansible-test.yml .github/workflows/codespell.yml .github/workflows/markdownlint.yml .github/workflows/qemu-kvm-integration-tests.yml .github/workflows/shellcheck.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.}