Skip to content

Commit

Permalink
Update Releasing section in contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
loosla committed Sep 10, 2024
1 parent 798111c commit d1def6c
Showing 1 changed file with 15 additions and 46 deletions.
61 changes: 15 additions & 46 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,53 +194,22 @@ to do so. Travis also runs shellcheck.

## Releasing

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).
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).
`doctl` follows [semantic versioning](https://semver.org), ask if you aren't sure.

1. Tag the release using `BUMP=(bugfix|feature|breaking) make tag`.
(Bugfix, feature and breaking are aliases for semver's patch, minor and major.
BUMP will also accept `patch`, `minor` and `major`, if you prefer). The command
assumes you have a remote repository named `origin` pointing to this
repository. If you'd prefer to specify a different remote repository, you can
do so by setting `ORIGIN=(preferred remote name)`.

The new tag triggers the release.

### 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.

### Updating Homebrew
1. Synchronize your local repository with all the tags that have been created or updated on the remote main branch
```bash
git checkout main
git pull --tags
```

Using the url and sha from the github release, update the
[homebrew formula](https://github.com/Homebrew/homebrew-core/blob/master/Formula/doctl.rb).
You can use `brew bump-formula-pr doctl`, or
1. Creates a new tag and push the tag to the remote repository named origin
```bash
git tag <new-tag> # Example: git tag v1.113.0
git push origin tag <new-tag> # Example: git push origin tag v1.113.0
```

1. fork `homebrew-core`
1. create a branch named `doctl-<version>`
1. update the url and the sha256 using the values for the archive in the github release
1. commit your changes
1. submit a PR to homebrew
To learn a bit more about how that all works, check out [goreleaser](https://goreleaser.com/intro)
and the config we use for it: [.goreleaser.yml](https://github.com/digitalocean/doctl/blob/main/.goreleaser.yml)

0 comments on commit d1def6c

Please sign in to comment.