Repository navigation
Skip image builds and runtime tests for docs-only changes - #410
Closed
cooktheryan wants to merge 1 commit into
Closed
cooktheryan wants to merge 1 commit into
cooktheryan wants to merge 1 commit into
Conversation
Signed-off-by: Ryan Cook <rcook@redhat.com>
|
Sorry @cooktheryan, you've used your own review budget of 250,000 diff characters for the last 7 days. You can request another review in 6 days and 17 hours by commenting |
Reviewer's GuideIntroduces a reusable, conservative Git change-scope workflow and applies job-level gating across runtime-heavy CI and publication workflows, so documentation-only changes continue to run Sphinx validation while skipping image builds, Go tests, integration matrices, and publishing without changing existing check identities or runtime job configuration. Sequence diagram for CI change classificationsequenceDiagram
participant GitHub
participant Scope as ci-scope workflow
participant Git as Git repository
participant Classifier as ci-change-scope.py
participant Jobs as Runtime/image jobs
participant Docs as Sphinx validation
GitHub->>Scope: workflow_call
Scope->>Git: checkout fetch-depth=0
Scope->>Scope: Test change classification
Scope->>Classifier: runtime_required(CI_EVENT, CI_BASE, CI_HEAD)
Classifier->>Git: git merge-base(base, head)
Classifier->>Git: git diff --name-only --no-renames
Git-->>Classifier: changed paths
Classifier-->>Scope: runtime=true or runtime=false
Scope-->>GitHub: runtime output
alt runtime=false
GitHub->>Docs: run Sphinx validation
GitHub-->>Jobs: skip runtime/image jobs
else runtime=true
GitHub->>Jobs: run builds and runtime tests
Jobs->>Publish: enable publication when event/ref permits
end
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
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
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.
Documentation-only changes currently run image builds, Go tests, and the full Podman integration matrix. Add a shared lightweight Git change classifier and gate every runtime/image job on its result while keeping Sphinx validation active. Docs-only PRs/main pushes now skip heavy jobs and publication.
Treat docs/**, root Markdown, and Read the Docs config as documentation. Code, examples, dependency files, scripts, workflow/action changes, mixed changes, and unknown paths run the full suite. Scheduled/manual sample checks remain enabled; missing or empty Git comparisons conservatively run tests. Job-level gating preserves existing check names and avoids workflow-filter pending checks.
Validation: six classifier tests including real Git history and code-to-docs renames; actual PR #409 classifies runtime=false; actionlint; strict Sphinx build; diff checks. Verified that all existing job steps, matrices, permissions, and runner settings are preserved. This CI change itself runs the full checks.
Summary by Sourcery
Gate resource-intensive runtime and image CI jobs on a shared documentation-only change classifier while continuing lightweight validation for documentation changes.
New Features:
Enhancements:
CI: