docs: add workflow trigger conventions reference#57
Merged
DevSecNinja merged 1 commit intomainfrom May 1, 2026
Merged
Conversation
Codifies the org-wide rules we converged on across truenas-apps and dotfiles: pull_request-only as default for CI; push:main only when there's post-merge-only work; concurrency cancellation patterns; notify-irm gating (do NOT gate on github.event_name == 'push'); tag-push vs release:created for release-publish workflows; release-please draft-publish flow. Cross-linked from release-please-onboarding.md and indexed in README.md. Real motivating PRs cited inline: dotfiles#263, #265, #266; truenas-apps#317, #325.
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.
Why
We've converged on a consistent set of GitHub Actions trigger / concurrency / IRM patterns across truenas-apps and dotfiles. Without a written reference each new repo (or each future me) re-derives them — and gets the subtle traps wrong (
event_name == 'push'silently skippingworkflow_dispatchreruns;release: creatednot firing reliably from GitHub App tokens; etc.).What
New page
docs/workflow-trigger-conventions.mdcovering:pull_request-only for CI; whenpush: mainis justified).pull_request_targetcasually.notify-irmrules: gate ongithub.ref == 'refs/heads/main'only; do not also gate ongithub.event_name == 'push'; don't add to PR-only CI workflows.release: created), Immutable Releases compatibility.Plus:
README.md: new table row linking to the doc.docs/release-please-onboarding.md: cross-link in the release flow section.Motivating PRs
release.ymlfromrelease: createdtopush: tags v*event_name == 'push'gate fromnotify-irmpush: mainfrom PR-validation workflows