Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Documentation Grafana Loki Maintaining Releasing Loki

Releasing Grafana Loki

This document is a series of instructions for core Grafana Loki maintainers to be able to publish a new Loki release.

Prerequisites

Each maintainer performing a release should perform the following steps once before releasing Loki.

Signing Tags and Commits

Add Existing GPG Key to GitHub

First, Navigate to your user’s SSH and GPG keys settings page. If the GPG key for the email address used to commit with Loki is not present, follow these instructions to add it:

1. Run gpg --armor --export <your email address>
2. Copy the output.
3. In the settings page linked above, click “New GPG Key”.
4. Copy and paste the PGP public key block.

Signing Commits and Tags by Default

To avoid accidentally publishing a tag or commit without signing it, you can run the following to ensure all commits and tags are signed:

bash Copy

git config --global commit.gpgSign true
git config --global tag.gpgSign true

macOS Signing Errors

If you are on macOS and using an encrypted GPG key, the gpg-agent may be unable to prompt you for your private key passphrase. This will be denoted by an error when creating a commit or tag. To circumvent the error, add the following into your ~/.bash_profile or ~/.zshrc, depending on which shell you are using:

Copy

export GPG_TTY=$(tty)

Performing the Release

1. Create a new branch to update CHANGELOG.md and references to version numbers across the entire repository (e.g. README.md in the project root).
2. Modify CHANGELOG.md with the new version number and its release date.
3. List all the merged PRs since the previous release. This command is helpful for generating the list (modifying the date to the date of the previous release): curl https://api.github.com/search/issues?q=repo:grafana/loki+is:pr+"merged:>=2019-08-02" | jq -r ' .items[] | "* [" + (.number|tostring) + "](" + .html_url + ") **" + .user.login + "**: " + .title'
4. Go through docs/ and find references to the previous release version and update them to reference the new version.
5. Without creating a tag, create a commit based on your changes and open a PR for updating the release notes.
   1. Until 852 is fixed, updating Helm and Ksonnet configs needs to be done in a separate commit following the release tag so that Helm tests pass.
6. Merge the changelog PR.
7. Create a new tag for the release.

   1. Once this step is done, the CI will be triggered to create release artifacts and publish them to a draft release. The tag will be made publicly available immediately.

   2. Run the following to create the tag:

      bash Copy

      RELEASE=v1.2.3 # UPDATE ME to reference new release
      git checkout master # If not already on master
      git pull
      git tag -s $RELEASE -m "tagging release $RELEASE"
      git push origin $RELEASE

8. Watch CircleCI and wait for all the jobs to finish running.

Updating Helm and Ksonnet configs

These steps should be executed after the previous section, once CircleCI has finished running all the release jobs.

1. Run bash ./tools/release_prepare.sh
2. When prompted for the release version, enter the latest tag.
3. When prompted for new Helm version numbers, the defaults should suffice (a minor version bump).
4. Commit the changes to a new branch, push, make a PR, and get it merged.

Publishing the Release Draft

Once the previous two steps are completed, you can publish your draft!

1. Go to the GitHub releases page and find the drafted release.
2. Edit the drafted release, copying and pasting notable changes from the CHANGELOG. Add a link to the CHANGELOG, noting that the full list of changes can be found there. Refer to other releases for help with formatting this.
3. Optionally, have other team members review the release draft so you feel comfortable with it.
4. Publish the release!

Versioning Loki docs on Grafana Website

Loki docs are versioned. Follow the below steps to version Loki docs for this release.

NOTE: Here $LOCAL_LOKI_PATH is your local path where Loki is checked out with correct $VERSION

1. Clone Grafana website repo
2. Create new branch git checkout -b $VERSION (replace $VERSION with current release version. e.g: v2.5.0)
3. Run mv content/docs/loki/next content/docs/loki/next.main
4. Run mkdir content/docs/loki/next
5. Run cp -R $LOCAL_LOKI_PATH/docs/sources/* content/docs/loki/next
6. Run scripts/docs-release.sh loki latest next
7. Run scripts/docs-release.sh loki $VERSION latest
8. Run mv content/docs/loki/next.main content/docs/loki/next
9. Update version_latest to $VERSION in content/docs/loki/_index.md
10. Docs will be generated for this release.
11. Create PR and Merge it after approval.