generated from honeycombio/.github
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
maint: Create Github release as part of release workflow (#53)
## Which problem is this PR solving? Creates a Github release as part of the release workflow. - Closes #36 ## Short description of the changes - Adds a release step to `.github/workflows/release.yaml` that creates a prerelease, draft Github release using [softprops/action-gh-release@v1](https://github.com/softprops/action-gh-release) - Adds a `.github/release.yaml` that automatically formats the release body with changes based on labeled PRs - Update `CHANGELOG.md` with previous two tags - Update `RELEASING.md` with notes on releasing process ## How to verify that this has the expected result The next pushed tag results in a release ! --------- Co-authored-by: JamieDanielson <jamieedanielson@gmail.com>
- Loading branch information
1 parent
0384f29
commit e901009
Showing
4 changed files
with
51 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# .github/release.yml | ||
|
||
changelog: | ||
exclude: | ||
labels: | ||
- no-changelog | ||
categories: | ||
- title: 💥 Breaking Changes 💥 | ||
labels: | ||
- "version: bump major" | ||
- breaking-change | ||
- title: 💡 Enhancements | ||
labels: | ||
- "type: enhancement" | ||
- title: 🐛 Fixes | ||
labels: | ||
- "type: bug" | ||
- title: 🛠 Maintenance | ||
labels: | ||
- "type: maintenance" | ||
- title: 🤷 Other Changes | ||
labels: | ||
- "*" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,15 @@ | ||
# Honeycomb eBPF Agent changelog | ||
|
||
## [0.0.2] - 2023-07-27 | ||
|
||
### Enhancements | ||
|
||
- feat: map IP address to pod name (#42) | @pkanal | ||
|
||
### Maintenance | ||
|
||
- maint: add developing notes and comments (#41) | @JamieDanielson | ||
|
||
## [0.0.1] - 2023-07-18 | ||
|
||
Initial release |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,13 @@ | ||
# Releasing | ||
|
||
- `Add steps to prepare release` | ||
- Update `CHANGELOG.md` with the changes since the last release. | ||
- Update version number in `main.go` | ||
- Update `CHANGELOG.md` with the changes since the last release. Consider automating with a command such as these two: | ||
- `git log $(git describe --tags --abbrev=0)..HEAD --no-merges --oneline > new-in-this-release.log` | ||
- `git log --pretty='%C(green)%d%Creset- %s | [%an](https://github.com/)'` | ||
- Commit changes, push, and open a release preparation pull request for review. | ||
- Once the pull request is merged, fetch the updated `main` branch. | ||
- Apply a tag for the new version on the merged commit (e.g. `git tag -a v1.2.3 -m "v1.2.3"`) | ||
- Push the tag upstream (this will kick off the release pipeline in CI) e.g. `git push origin v1.2.3` | ||
- Copy change log entry for newest version into draft GitHub release created as part of CI publish steps. | ||
- Make sure to "generate release notes" in github for full changelog notes and any new contributors | ||
- Publish the github draft release and this will kick off publishing to GitHub and the NPM registry. | ||
- Apply a tag for the new version on the merged commit (e.g. `git tag -a v0.1.0-alpha -m "v0.1.0-alpha"`) | ||
- Push the tag upstream (this will kick off the release pipeline in CI) e.g. `git push origin v0.1.0-alpha` | ||
- Ensure that there is a draft GitHub release created as part of CI publish steps. | ||
- Click "generate release notes" in GitHub for full changelog notes and any new contributors | ||
- Publish the GitHub draft release - if it is a prerelease (e.g. beta) click the prerelease checkbox. |