Skip to content

Commit

Permalink
Add instructions for releasing
Browse files Browse the repository at this point in the history
This PR adds instructions for creating releases.
  • Loading branch information
ben-z authored Oct 28, 2024
1 parent b1246ad commit 3982aa9
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
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.

0 comments on commit 3982aa9

Please sign in to comment.