Pre Release
Developmentpre-releasePre Release is an Agent Skill for development published in the rusq/slackdump repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Prepare this repository for a release. Use when asked to do pre-release checks, summarize changes since a previous tag, update WHATSNEW.md or changelog entries, update CONTRIBUTORS.md, audit command long help or docs for release-visible features, or verify release documentation consistency.
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/rusq/slackdump/blob/HEAD/.agents/skills/pre-release/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/pre-release, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
Pre-release
Use this skill for repository-local release-prep documentation passes. Ground every update in commit history, diffs, and current command behavior.
Workflow
-
Determine the release range.
- Use the base tag or version supplied by the user.
- If no base is supplied, inspect tags with
git tag --list 'v*' --sort=-version:refnameand infer the previous release tag. - Inspect changes with
git log --oneline <base>..HEAD,git diff --stat <base>..HEAD, andgit diff --name-only <base>..HEAD.
-
Update release notes when requested.
- Check whether the changelog file is a symlink before editing it.
- Preserve the existing changelog style and section order.
- Add the new version section above the previous release.
- Focus on user-visible features, behavior changes, bug fixes, migration notes, and documented workflows.
- Mention commands, flags, formats, and caveats exactly as implemented.
- Avoid internal-only refactors unless they materially affect users, maintainers, packaging, or contributors.
-
Update contributors when requested or as part of a full release prep.
- Compare
git shortlog -sne <base>..HEADandgit log --format='%aN <%aE>' <base>..HEADagainstCONTRIBUTORS.md. - Inspect individual commits and merge commits for contribution scope.
- Infer GitHub handles only from reliable local evidence such as PR branch names in merge commits or existing repository metadata.
- Add concise entries for new contributors and update the displayed total.
- Do not duplicate existing contributors; extend an existing entry when that is clearer.
- Compare
-
Audit command help and docs for release-visible changes.
- Search embedded help assets, command definitions, and docs for each release-note topic.
- Update only the help/docs that a user would naturally consult for the changed command, flag, format, or workflow.
- For Go files with inline long help, avoid Markdown backticks inside raw string literals unless the literal delimiter allows them.
- Keep documentation concise and practical: what changed, how to use it, and any important tradeoff.
-
Validate.
- Run
gofmton edited Go files. - Run targeted tests for touched Go packages when Go files changed.
- For Markdown-only changes, no full test run is required; say that explicitly.
- Review
git diff --stat, relevantgit diff, andgit status --short. - Preserve the user's staged and unstaged state; do not stage files unless asked.
- Run
Search Hints
- Changelog:
WHATSNEW.md,cmd/**/assets/*changelog*. - Contributors:
CONTRIBUTORS.md,git shortlog, merge commit messages. - Embedded command help:
cmd/**/assets/*.mdandLong:fields in Go files. - User docs:
doc/,README.md, command-specific usage files.
Final Response
Report:
- The release range inspected.
- Files changed.
- Validation commands run and results.
- Any notable staged vs unstaged state.