---
name: release-prep
description: Prepare a new release - bump action.yml image version, verify CHANGELOG entry and stage changes
disable-model-invocation: true
---

Args: VERSION (e.g. 0.61.0)

Steps:

1. Update `action.yml` — change the `image:` value to:
   `docker://jonasbn/github-action-spellcheck:$VERSION`

2. Update `README.md` - change the referenced use in the various configuration examples to match the new version:
   `uses: rojopolis/spellcheck-github-actions@$VERSION`

3. Check `CHANGELOG.md` for an entry matching `$VERSION`. If none exists, warn and stop — ask the user to add a changelog entry before continuing.

4. Create a PR for the changes to `action.yml`, `README.md`, and the new changelog entry in `CHANGELOG.md`. Wait for the PR to be merged before proceeding.

5. On merge:
   ```bash
   perl scripts/build.pl $VERSION
   ```

6. Check the return value of the build script. If it fails, show the error and stop. The build script does the tagging and pushing to GitHub and Docker Hub.

7. Confirm the tag was pushed