Skip to content

Commit

Permalink
Update release docs to include process for patch releases
Browse files Browse the repository at this point in the history
The doc is a simplified version of the one used for Tekton Pipelines,
without the use of milestones and specially labelled issues. This is
something we may consider in future but are not currently using.
  • Loading branch information
AlanGreene authored and tekton-robot committed Apr 5, 2022
1 parent b22ba60 commit cdb6444
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions tekton/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Tekton! This directory contains the
that we use.

* [How to create a release](#create-an-official-release)
* [How to create a patch release](#create-a-patch-release)
* [Automated nightly releases](#nightly-releases)
* [Setup releases](#setup)
* [npm packages](#npm-packages)
Expand All @@ -18,6 +19,21 @@ that we use.

To create an official release, follow the steps in the [release-cheat-sheet](./release-cheat-sheet.md)

## Create a patch release

Sometimes we'll find bugs that we want to backport fixes for into previous releases
or discover things that were missing from a release that are required by upstream
consumers of a project. In that case we'll make a patch release. To make one:

1. Create a branch for the release named `release-<version number>.x`, e.g. [`release-v0.18.x`](https://github.com/tektoncd/dashboard/tree/release-v0.18.x)
and push it to the repo https://github.com/tektoncd/dashboard (you may need help from
[an OWNER](../OWNERS) with permission to push) if that release branch does not exist.
1. Use [git cherry-pick](https://git-scm.com/docs/git-cherry-pick) to cherry pick the
fixes from main into the release branch you have created (use `-x` to include
the original commit information).
1. [Create an official release](#create-an-official-release) for the patch, with the
[patch version incremented](https://semver.org/)

## Nightly releases

The nightly release pipeline is
Expand Down

0 comments on commit cdb6444

Please sign in to comment.