Skip to content

Conversation

@dsclear-amd
Copy link
Contributor

@dsclear-amd dsclear-amd commented Dec 19, 2025

Motivation

Currently, full installation and unit test runs are conducted even for changes of only documentation files; this greatly slows down docs development work.

Technical Details

This change modifies two of the largest workflows, azure-ci-dispatcher.yml and therock-ci.yml, as well as many rocprofiler workflows, to not trigger on PRs or pushes that consist entirely of documentation changes.

JIRA ID

AIROCDOC-78, AIROCDOC-424, AIROCDOC-425

Test Plan

  1. Created a test branch (for example, test_branch; actual test users/dsclear/shorten_workflows_test_root) with the changes in this PR, branched from develop.
  2. Branched test_branch_bin_feeder and test_branch_text_feeder from test_branch.
  3. Modified test_branch_bin_feeder to add a new .h file, and submitted a PR from test_branch_bin_feeder into test_branch (Test PR; do not merge. Test PR to trigger CI/CD workflows. #2566).
  4. Modified test_branch_text_feeder to add a new .txt file, and submitted a PR from test_branch_text_feeder into test_branch (Test PR; do not merge. Test PR to trigger CI/CD workflows (documentation-only) #2567).

Test Result

The test_branch_bin_feeder PR caused the modified workflows to still trigger, as expected. The test_branch_text_feeder PR caused the modified workflows to be skipped, as desired.

@dsclear-amd dsclear-amd requested a review from a team as a code owner December 19, 2025 21:14
@github-actions github-actions bot added the github actions Pull requests that update GitHub Actions code label Dec 19, 2025
Specifically, sets azure-ci-dispatcher.yml and therock-ci.yml to
	not trigger when the change consists entirely of .txt,
	.md, or .rtf files.
Most notably, any changes in the 'docs' folder, or the 'docs' folder in
	any project, are now excluded.
@dsclear-amd dsclear-amd force-pushed the user/dsclear/shorten_pr_checks_for_docs_changes_commitable branch from 8a4520b to d3762e4 Compare January 5, 2026 21:12
This workflow should now correctly skip docs-only changes, even on
pushes.
@dsclear-amd dsclear-amd marked this pull request as draft January 6, 2026 22:56
@dsclear-amd dsclear-amd marked this pull request as ready for review January 6, 2026 23:30
@neon60 neon60 requested a review from ammallya January 8, 2026 17:10
Specifically, fixes the old incorrect paths like '**.txt'
	to be of the style '**/*.txt'.
@dsclear-amd dsclear-amd marked this pull request as draft January 8, 2026 19:57
Specifically, changes them from the incorrect '**.txt' style
	to '**/*.txt'.
@dsclear-amd dsclear-amd marked this pull request as ready for review January 8, 2026 20:07
@neon60 neon60 requested a review from a team January 9, 2026 15:05
Copy link
Contributor

@geomin12 geomin12 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks fine, although this will break PRs for therock-ci.yml, as TheRock CI is required to run

please add here for TheRock:

SKIPPABLE_PATH_PATTERNS = [

@dsclear-amd dsclear-amd requested a review from geomin12 January 9, 2026 17:56
@lamb-j
Copy link
Contributor

lamb-j commented Jan 9, 2026

Is it safe to assume changes to *.txt are non-functional (and don't require testing?). For example, maybe changes to a CMakeLists.txt?

@dsclear-amd
Copy link
Contributor Author

Is it safe to assume changes to *.txt are non-functional (and don't require testing?). For example, maybe changes to a CMakeLists.txt?

Excellent point, I didn't consider CMakeLists.txt. I'll remove ignoring .txt files in favour of just listing docs-specific .txt files we know to ignore.

@dsclear-amd dsclear-amd marked this pull request as draft January 9, 2026 20:31
Specifically, instead of excluding all .txt files (which would catch
	things like CMakeLists.txt), now only specific .txt files
	are excluded.
@dsclear-amd dsclear-amd marked this pull request as ready for review January 9, 2026 21:38
Copy link
Contributor

@geomin12 geomin12 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm for TheRock CI

dsclear-amd and others added 2 commits January 12, 2026 16:12
This is because using both paths and paths-ignore at the same time
	is not allowed.
@dsclear-amd dsclear-amd requested a review from geomin12 January 12, 2026 21:38
@dsclear-amd dsclear-amd merged commit d5f490f into develop Jan 12, 2026
154 of 168 checks passed
@dsclear-amd dsclear-amd deleted the user/dsclear/shorten_pr_checks_for_docs_changes_commitable branch January 12, 2026 23:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

github actions Pull requests that update GitHub Actions code organization: ROCm

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants