Conversation
Addresses issue #96 - creates a comprehensive checklist covering: - Pre-release documentation and testing steps - Release creation using task automation - Publishing workflow with external listings update - Post-release verification - Rollback procedures if needed The checklist focuses on manual steps and optimizes for multitasking (e.g. updating external listings while CI builds).
There was a problem hiding this comment.
Pull request overview
Adds a dedicated release checklist document to standardize the manual steps involved in publishing a Photofield release (issue #96), including pre-release validation, running the automated release tasks, publishing, verification, and rollback guidance.
Changes:
- Introduces a new
RELEASE_CHECKLIST.mdcovering prerequisites, pre-release steps, publishing flow, and post-release verification. - Documents use of existing Taskfile automation (
task release,task release:push, etc.) and changie entry workflows. - Adds operational notes for rollback and supply-chain attestation expectations.
| - Opens the version file in your editor for review/editing | ||
| - Merges changes into CHANGELOG.md | ||
| - Commits with "Release vX.Y.Z" message | ||
| - Creates git tag |
There was a problem hiding this comment.
task release currently runs code --wait .changes/$(changie latest).md (Taskfile.yml:92). This checklist says it “opens the version file in your editor”, but in practice it specifically requires the VS Code code CLI to be installed/in PATH (or the task will fail). Please adjust the wording to match the actual behavior and/or document an alternative flow for users without code (e.g., manually edit the file then run the remaining changie/git steps).
| - Opens the version file in your editor for review/editing | |
| - Merges changes into CHANGELOG.md | |
| - Commits with "Release vX.Y.Z" message | |
| - Creates git tag | |
| - Opens the version file in VS Code via the `code` CLI (`code --wait ...`) for review/editing | |
| - Merges changes into CHANGELOG.md | |
| - Commits with "Release vX.Y.Z" message | |
| - Creates git tag | |
| - If you don't have the VS Code `code` CLI installed/in `PATH`, manually open the latest `.changes/<version>.md` file in your editor, edit it as needed, then run the remaining changie/git steps from the release task manually. |
| - [ ] Delete the release commit locally: `git reset --hard HEAD~1` | ||
| - [ ] Force push: `git push -f origin main` | ||
| - [ ] Delete GitHub Release draft if created |
There was a problem hiding this comment.
The “After pushing to GitHub” rollback procedure recommends git reset --hard HEAD~1 followed by git push -f origin main. Force-pushing main rewrites shared history and can disrupt other contributors (and any branch protections may block it). Consider updating this section to prefer safer recovery options (e.g., reverting the release commit and cutting a follow-up release), or add clear guidance to coordinate and ensure no intervening commits before rewriting history.
1 participant
Closes #96
Adds a comprehensive release checklist covering the most common steps when releasing Photofield.
Key sections:
task releaseautomationThe checklist focuses on manual steps that need human attention rather than explaining what CI does automatically.