Skip to content

Commit

Permalink
create snap readme; add go install github.com/digitalocean/github-cha…
Browse files Browse the repository at this point in the history
…ngelog-generator@latest

==> list merged PRs since last release to review changes to release
  • Loading branch information
loosla committed Sep 13, 2024
1 parent 4766510 commit f595a6a
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 3 deletions.
10 changes: 7 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,9 +194,13 @@ to do so. Travis also runs shellcheck.

## Releasing

1. Use [github-changelog-generator](https://github.com/digitalocean/github-changelog-generator)
to list the changes since the last release
and decide what kind of release you are doing (bugfix, feature or breaking).
To cut a release, push a new tag (versioning discussed below).

### Tagging a release

1. Run `make changes` to review the changes since the last
release. Based on the changes, decide what kind of release you are
doing (bugfix, feature or breaking).
`doctl` follows [semantic versioning](https://semver.org), ask if you aren't sure.

1. Synchronize your local repository with all the tags that have been created or updated on the remote main branch
Expand Down
20 changes: 20 additions & 0 deletions snap/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Snap

Snap packages are automatically built and uploaded as part of the GitHub Actions
release workflow.

To build a snap package locally for testing, first install `snapcraft`.

On Ubuntu, run:

sudo snap install snapcraft --classic

Or on MacOS, run:

brew install snapcraft

Finally, build the package by running:

make snap

More details about the snap package can be found in the `snap/snapcraft.yaml` file.

0 comments on commit f595a6a

Please sign in to comment.