Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add instructions for releasing #21

Merged
merged 1 commit into from
Oct 28, 2024
Merged

Add instructions for releasing #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,13 @@ Run the following to use the CLI:
```sh
node ./dist/cli/index.js
```

## Releasing

Releases are manually created from the [Releases page](https://github.com/WATonomous/watcloud-emails/releases).
CI will automatically build the tarball and publish it to the release page.
Release notes can be auto-generated via the web interface.

Please follow [semantic versioning](https://semver.org/) when creating tags for releases.
Tags should be prefixed with `v` (e.g. `v1.0.0`).
Version numbers less than `1.0.0` should be considered unstable and may have breaking changes in minor versions.