Repository navigation
chore: add release-readiness checklist reminder workflow - #3952
Open
michaelmalave wants to merge 5 commits into
Open
michaelmalave wants to merge 5 commits into
michaelmalave wants to merge 5 commits into
Conversation
Advisory, non-blocking GitHub Action that posts a sticky comment linking
the Dev Tools Release Readiness Checklist on customer-facing PRs, visible
only to internal Heroku contributors (MEMBER/OWNER), greeting the author
by GitHub login. No elevated token, no GitHub App, no PR-head checkout.
AUTHOR is passed via env: and referenced only as the bash var $AUTHOR in
run: (never as a raw ${{ }} expression) — safe because the job already
gates on MEMBER/OWNER and a GitHub login is charset-constrained
([a-zA-Z0-9-], <=39 chars), so it cannot inject markdown or shell.
Mirrors the pr-size-label.yml house pattern for pull_request_target
safety and try()-guarded advisory writes.
michaelmalave
changed the title
This branch was successfully deployed
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
2 participants
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.
Summary
Adds a small, advisory GitHub Actions workflow that leaves a friendly reminder on pull requests that change something customers see or use. When an internal contributor opens such a PR, the bot posts a single sticky comment — greeting the author by name — linking the Dev Tools Release Readiness Checklist (get a CX review; optionally share the PRD/roadmap, Dev Center docs, and a target release date). It never blocks the PR and cleans the comment up if the PR later stops touching customer-facing files.
.github/workflows/release-readiness-checklist.yml.MEMBER/OWNER); external PRs are skipped entirely.Type of Change
Breaking Changes (major semver update)
!after your change type to denote a change that breaks current behaviorFeature Additions (minor semver update)
Patch Updates (patch semver update)
Testing
Notes:
The workflow triggers on
pull_request_targetin this repo, so it cannot run from a fork PR's CI before merge. It was validated statically.Steps:
ruby -ryaml -e "YAML.load_file('.github/workflows/release-readiness-checklist.yml')"— Expect: parses without error.uses:/checkout step (pure bash, so no PR-head code is ever checked out).author_association(MEMBER/OWNER) and that only trusted context (repository, PR number, author association/login) is passed viaenv:— never interpolated intorun:.Screenshots (if applicable)
Related Issues
The linked checklist lives in
heroku/engineering-docs(teams/developer-tooling/release-readiness-checklist.md); its link resolves once that doc merges.