Skip to content

Add a comment to show that workflows are externally managed - #584

Merged
TBExtent merged 1 commit into
mainfrom
add-managed-workflow-disclaimer
Nov 3, 2026
Merged

TBExtent merged 1 commit into
mainfrom
add-managed-workflow-disclaimer

Conversation

@TBExtent

@TBExtent TBExtent commented Nov 2, 2026

Copy link
Copy Markdown
Contributor

No description provided.

@TBExtent
TBExtent requested a review from a team as a code owner November 2, 2026 17:09
@coderabbitai

coderabbitai Bot commented Nov 2, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

Run configuration

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • Trigger review

No actionable comments were generated in the recent review.

Summary

Add a shared disclaimer stating that generated workflows are managed by StackHPC Release Train and should not be edited manually. Render it at the top of six workflow templates.

The source repository role now defines a managed workflow disclaimer and renders it in six GitHub Actions workflow templates.

Changes: Managed workflow disclaimers

Layer / File(s) Summary
Define and render the disclaimer
ansible/roles/source-repo-sync/defaults/main.yml, ansible/roles/source-repo-sync/templates/*.jinja
A default value provides a management notice, repository link and request not to edit manually. Six workflow templates render the disclaimer before their workflow definitions.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: Minimal · previous review 2b5e2

The change adds externally managed notices to generated workflows. No merge-blocking risk is identified; merge after normal checks pass.

Pre-merge checks: Passed 3
Check name Status Explanation
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (7 skipped: 7 unsupported.)

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Tip

🎯 Customize your risk assessments

Guide how CodeRabbit assesses merge risk and security architecture risk. Highlight sensitive changes and explain your security boundaries using Merge Risk Instructions and Security Risk Instructions in your review settings. Security architecture risk assessments require the Advanced plan or above.

✅ Automatic approvals, with your rules

Let CodeRabbit approve pull requests once required threads are resolved, pre-merge checks pass, and your risk limits are met. Enable Automatic approvals in review settings, with overrides for teams or file paths.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

CodeRabbit Verify

  • Run CodeRabbit Verify to test the changes in this pull request.
Recent review info
Run configuration
Commits

Reviewing files that changed from the base of the PR and between 4b4ecba and 2b5e27d.

Files selected for processing: 7
  • ansible/roles/source-repo-sync/defaults/main.yml
  • ansible/roles/source-repo-sync/templates/lint-collection.jinja
  • ansible/roles/source-repo-sync/templates/publish-collection.jinja
  • ansible/roles/source-repo-sync/templates/publish-role.jinja
  • ansible/roles/source-repo-sync/templates/tag-and-release.jinja
  • ansible/roles/source-repo-sync/templates/tox.jinja
  • ansible/roles/source-repo-sync/templates/upstream-sync.jinja

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

@TBExtent
TBExtent force-pushed the add-managed-workflow-disclaimer branch from 2b5e27d to ae29d7f Compare November 2, 2026 17:11
@TBExtent
TBExtent marked this pull request as draft November 3, 2026 09:38
@TBExtent
TBExtent force-pushed the add-managed-workflow-disclaimer branch from 79c81e7 to 52e92f3 Compare November 3, 2026 10:01
@TBExtent
TBExtent force-pushed the add-managed-workflow-disclaimer branch from 52e92f3 to b1a2093 Compare November 3, 2026 10:09
@TBExtent
TBExtent marked this pull request as ready for review November 3, 2026 10:09
@Alex-Welsh

Copy link
Copy Markdown
Member

@TBExtent what's up with all the removed stuff?

@Alex-Welsh

Copy link
Copy Markdown
Member

@TBExtent what's up with all the removed stuff?

Removal has since been removed, looks fine now

@TBExtent

TBExtent commented Nov 3, 2026

Copy link
Copy Markdown
Contributor Author

@TBExtent what's up with all the removed stuff?

Removal has since been removed, looks fine now

The removed removal was so that I didn't open pull requests against all the repos when I was testing

@TBExtent
TBExtent merged commit 4945029 into main Nov 3, 2026
5 checks passed
@TBExtent
TBExtent deleted the add-managed-workflow-disclaimer branch November 3, 2026 10:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants