Release
Release a new version of Synapse — bump version, update CHANGELOG, commit, tag, and create GitHub release.From its SKILL.md
npx -y skills add Vincentwei1021/Synapse --skill releaseAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
What its file declares
Copied from the file, not written here
The file declares its own license as AGPL-3.0. That is the author’s claim about this one file, and it is not the same thing as the license GitHub reports for the repository, which is listed with the other numbers below.
SKILL.md
2.7 KB, as published. Nobody here has run it
Synapse Release Process
Step-by-step guide to cut a new release of Synapse.
Prerequisites
- All changes for the release are merged into
main ghCLI is authenticated (gh auth status)- Working tree is clean (
git status)
Steps
1. Identify the diff since last release
# Find the previous release tag
git tag -l 'v*' --sort=-version:refname | head -5
# List commits since previous tag
git log --oneline v<PREV>..HEAD
# Review each commit for CHANGELOG-worthy changes
git show --stat <commit-hash>
2. Update CHANGELOG.md
Add a new section at the top of CHANGELOG.md, below the # Changelog header and above the previous release section. Use this structure:
## [X.Y.Z] - YYYY-MM-DD
### Added
- **Feature name**: Description of what was added.
### Changed
- **Area**: Description of what changed.
### Fixed
- **Bug name**: Description of what was fixed.
### Plugin
- Plugin version changes if applicable.
---
Rules:
- Only include commits after the previous release tag
- Group by Added / Changed / Fixed / Deprecated / Removed / Plugin
- Omit empty groups
- Each entry should start with a bold label followed by a concise description
- Separate from the previous release section with
---
3. Bump version in package.json
# Edit package.json "version" field
# e.g., "0.1.0" → "0.1.1"
Follow semver:
- patch (0.1.0 → 0.1.1): bug fixes, minor additions
- minor (0.1.0 → 0.2.0): new features, non-breaking changes
- major (0.1.0 → 1.0.0): breaking changes
4. Commit
git add CHANGELOG.md package.json
git commit -m "chore: bump version to vX.Y.Z and update CHANGELOG"
git push
5. Create GitHub release with tag
gh release create vX.Y.Z \
--target main \
--title "vX.Y.Z" \
--notes "$(cat <<'EOF'
<paste only the new version's CHANGELOG section here, without the ## header>
EOF
)"
Important: The --notes should contain only the new version's content, not the entire CHANGELOG file.
6. Verify
# Confirm tag exists
git tag -l 'vX.Y.Z'
# Confirm release is visible
gh release view vX.Y.Z
Checklist
-
git log v<PREV>..HEADreviewed — no commits missed - CHANGELOG.md updated with correct date and content
- package.json version bumped
- Committed and pushed to main
-
gh release createwith tag on main - Release notes contain only the new version's section
-
gh release viewconfirms everything looks correct