action-prepare-release

Imported from dnd-mapp/action-prepare-release (AGENTS.md). Install upstream with npx skills add dnd-mapp/action-prepare-release. Copyright stays with the author.

Agent instructions

Project

This repository is the composite GitHub Action dnd-mapp/action-prepare-release. The action in action.yaml prepares the next release with the changelog bin from @dnd-mapp/changelog-tools, and opens its chore: release X.Y.Z pull request with a GitHub App token. Read CONTRIBUTING.md for the layout, the checks, the release steps, and the commit and branch conventions.

• Keep the action to opening the release pull request. Tagging, staging the package, and creating the GitHub Release belong elsewhere.
• Commit through the GraphQL createCommitOnBranch mutation, never with git push, so GitHub signs the commit for the signed-commits rule.
• Report every failure as an error annotation, with run_annotated or annotate_error from scripts/annotate.sh, so the run summary shows why the action failed.
• Pass inputs and step outputs into run scripts through env, and read them as shell variables. A ${{ }} expression belongs in an env value, never inside the script.
• Treat the input and output names and their defaults as a contract. When you change one, update action.yaml, the README tables, and the changelog in the same commit, and mark the change as breaking.
• Pin every third-party action to a commit SHA and note the version in a comment.
• Run format-check, lint-md, and actionlint before you commit.

Writing style

• Never hard wrap prose. Write each paragraph or list item on a single line and let the editor wrap it.
• Use US spelling only, for example "color", "behavior", and "initialize".
• Keep every sentence at or under 40 words.
• Pretty print Markdown tables so the columns line up in the source.
• Give every separator line alignment markers (:---, :---:, or ---:).
• Carry the separator line from edge to edge of each column, with no spaces between the pipes and the dashes.

Example:

After creating or updating a file that contains prose, including Markdown files, do reading passes over it until every rule above is satisfied. Fix any violation you find, then read the file again.

Pull requests

Turn on auto-merge for every pull request you open, so it merges as soon as it is approved and the checks pass.

1. Open the pull request with gh pr create.
2. Run gh pr merge <number> --auto --merge on it. A merge commit is the only merge method the repository allows.

• A draft cannot have auto-merge. Mark it ready with gh pr ready <number> first, then run the command above.
• When the user asks to keep a pull request open, leave auto-merge off. If it is already on, turn it off with gh pr merge <number> --disable-auto.
• Release pull requests (chore: release X.Y.Z) come from the Prepare release workflow, which turns on auto-merge itself. Only the first release, 1.0.0, is prepared by hand, because changelog release needs a release to bump from. The release starts only when the maintainer pushes the vX.Y.Z tag on the merge commit by hand, as CONTRIBUTING.md describes.