Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add instructions for releasing a new version #1120

Merged
merged 1 commit into from
Oct 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,16 @@ export default defineConfig({
label: 'Known issues',
link: '/known-issues',
},
{
label: 'Project internals',
collapsed: true,
items: [
{
label: 'Releasing a new version',
link: '/internal/releasing',
}
]
},
],
}),
tailwind({
Expand Down
24 changes: 24 additions & 0 deletions docs/src/content/docs/internal/releasing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: "Releasing a new version"
---

Releasing a new version of Tanka requires a couple of manual and automated steps.
This guide will give you a runbook on how to do them in the right order.

## 1. Create a release tag

1. Pull the latest changes from the `main` branch to your local clone.
1. Create a new tag with the prefix `v` (e.g. `v0.28.0`).
1. Push that tag back to GitHub.

This starts multiple GitHub workflows that will produce binaries, a Docker image, and also a new GitHub release that is *marked as draft*.

## 2. Add changelog to the release notes

Once all these actions have finished, go to <https://github.com/grafana/tanka/releases> and you should see the new draft release.
Click the pencil icon ("edit") at the top-right and go to the last line of the text body.
Now hit the "Generate release notes" button to add a changelog to the end of the release notes.

## 3. Publish the release notes

Once you've check that the release looks fine (e.g. no broken links, no missing version numbers in the download paths) click the "Publish release" button.
Loading