Skip to content

Commit

Permalink
Add HACKING.md notes on how to create a new tagged release
Browse files Browse the repository at this point in the history
  • Loading branch information
benhoyt committed Mar 26, 2023
1 parent e36954a commit 26c0c43
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion HACKING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Hacking on Pebble

- [Running the daemon](#running-the-daemon)
- [Using the CLI client](#using-the-cli-client)
- [Using Curl to hit the API](#using-curl-to-hit-the-api)
- [Running the tests](#running-the-tests)
- [Creating a release](#creating-a-release)

Hacking on Pebble is easy. It's written in Go, so install or [download](https://golang.org/dl/) a copy of the latest version of Go. Pebble uses [Go modules](https://golang.org/ref/mod) for managing dependencies, so all of the standard Go tooling just works.

To compile and run Pebble, use the `go run` command on the `cmd/pebble` directory. The first time you run it, it will download dependencies and build packages, so will take a few seconds (but after that be very fast):
Expand Down Expand Up @@ -127,4 +133,16 @@ ok github.com/canonical/pebble/client (cached)
? github.com/canonical/pebble/cmd [no test files]
ok github.com/canonical/pebble/cmd/pebble 0.165s
...
```
```


## Creating a release

To create a new tagged release, go to the [GitHub Releases page](https://github.com/canonical/pebble/releases) and:

- Click "Create a new release"
- Enter the version tag (eg: `v1.2.3`) and select "Create new tag: on publish"
- Enter a release title: include the version tag and a short summary of the release
- Write release notes: describe new features and bug fixes, and include a link to the full list of commits

Binaries will be created and uploaded automatically to this release by the [release.yml](https://github.com/canonical/pebble/blob/master/.github/workflows/release.yml) GitHub Actions job.

0 comments on commit 26c0c43

Please sign in to comment.