There's a few scenarios that might prompt a release:
Scenario | Release type |
---|---|
Breaking changes to existing macros | major |
New functionality | minor |
Fixes to existing macros | patch |
- Begin a new release by clicking here
- Click "Choose a tag", then paste your version number (with no "v" in the name), then click "Create new tag: x.y.z. on publish"
- The “Release title” will be identical to the tag name
- Click the "Generate release notes" button
- Copy and paste the generated release notes into
CHANGELOG.md
, reformat to match previous entries, commit, and merge into themain
branch (example) - Click the "Publish release" button
- This will automatically create an "Assets" section containing:
- Source code (zip)
- Source code (tar.gz)
- This will automatically create an "Assets" section containing:
- Delete the automatic Zapier post (example of one intentionally not deleted) and replace it with a custom post in the
#package-ecosystem
channel in “The Community Slack” using the content from the tagged release notes (but replace GitHub handles with Slack handles) (example)