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

Add release documentation #2516

Merged
merged 1 commit into from
Oct 10, 2022
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
38 changes: 7 additions & 31 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,41 +33,17 @@ Some of the features the Tekton Dashboard supports:

![Dashboard UI workloads page](dashboard-ui.jpg)

## Getting Started

- Try out the [tutorial](./tutorial.md) to install the Dashboard and explore some of its features

- For more details about installation options, access control, and customisation, see the [install doc](./install.md)

## Further reading
## Read the docs

- [Installing Tekton Dashboard](./install.md)
- Jump in with [the "Getting started" tutorial!](./tutorial.md)
- Take a look at our [roadmap](https://github.com/tektoncd/dashboard/blob/main/roadmap.md)
- Discover our [releases](https://github.com/tektoncd/dashboard/blob/main/releases.md)
- Try our [walk-throughs](./walkthrough/README.md) for more details on deploying and configuring the Tekton Dashboard for some common scenarios
- Learn how to add additional resource types to the Tekton Dashboard using [extensions](./extensions.md)
- Take a look at our [roadmap](https://github.com/tektoncd/dashboard/blob/main/roadmap.md)

## Which version should I use?

| Version | Docs | Pipelines | Triggers |
| ------- | ---- | --------- | -------- |
| [HEAD](https://github.com/tektoncd/dashboard/blob/main/DEVELOPMENT.md) | [Docs @ HEAD](https://github.com/tektoncd/dashboard/tree/main/docs) | v0.35.x - v0.40.x | v0.15.x - 0.21.x |
| [v0.29.2](https://github.com/tektoncd/dashboard/releases/tag/v0.29.2) | [Docs @ v0.29.2](https://github.com/tektoncd/dashboard/tree/v0.29.2/docs) | v0.35.x - v0.39.x | v0.15.x - 0.21.x |
| [v0.28.0](https://github.com/tektoncd/dashboard/releases/tag/v0.28.0) | [Docs @ v0.28.0](https://github.com/tektoncd/dashboard/tree/v0.28.0/docs) | v0.35.x - v0.37.x | v0.15.x - 0.20.x |
| [v0.27.0](https://github.com/tektoncd/dashboard/releases/tag/v0.27.0) | [Docs @ v0.27.0](https://github.com/tektoncd/dashboard/tree/v0.27.0/docs) | v0.25.x - v0.36.x | v0.15.x - 0.20.x |
| [v0.26.0](https://github.com/tektoncd/dashboard/releases/tag/v0.26.0) | [Docs @ v0.26.0](https://github.com/tektoncd/dashboard/tree/v0.26.0/docs) | v0.25.x - v0.35.x | v0.15.x - 0.19.x |
| [v0.25.0](https://github.com/tektoncd/dashboard/releases/tag/v0.25.0) | [Docs @ v0.25.0](https://github.com/tektoncd/dashboard/tree/v0.25.0/docs) | v0.25.x - v0.34.x | v0.15.x - 0.19.x |
| [v0.24.2](https://github.com/tektoncd/dashboard/releases/tag/v0.24.2) | [Docs @ v0.24.2](https://github.com/tektoncd/dashboard/tree/v0.24.2/docs) | v0.25.x - v0.32.x | v0.15.x - 0.18.x |
| [v0.23.1](https://github.com/tektoncd/dashboard/releases/tag/v0.23.1) | [Docs @ v0.23.1](https://github.com/tektoncd/dashboard/tree/v0.23.1/docs) | v0.25.x - v0.30.x | v0.15.x - 0.17.x |
| [v0.22.1](https://github.com/tektoncd/dashboard/releases/tag/v0.22.1) | [Docs @ v0.22.1](https://github.com/tektoncd/dashboard/tree/v0.22.1/docs) | v0.25.x - v0.29.x | v0.15.x - 0.17.x |

<details>
<summary>Other versions</summary>

It is **strongly recommended** to use the **v0.22.1, v0.23.1, v0.24.2, or v0.25.0** releases or newer.
- These releases contain a security fix
- Earlier versions are deprecated and should be used for **development or isolated usage only**

For details of earlier versions, see [legacy releases](./legacy-releases.md)
</details>
Version specific links are available in the [releases](https://github.com/tektoncd/dashboard/blob/main/releases.md) page and on the
[Tekton website](https://tekton.dev/docs).

## Browser support

Expand Down
8 changes: 2 additions & 6 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ This guide explains how to install Tekton Dashboard. It covers the following top

- [Before you begin](#before-you-begin)
- [Pre-requisites](#pre-requisites)
- [Which version should I use](#which-version-should-i-use)
- [Installing Tekton Dashboard on Kubernetes](#installing-tekton-dashboard-on-kubernetes)
- [Installing Tekton Dashboard on OpenShift](#installing-tekton-dashboard-on-openshift)
- [Installing with the installer script](#installing-with-the-installer-script)
Expand Down Expand Up @@ -41,12 +40,9 @@ or other projects may require a newer version.
- Tekton Pipelines must be installed in the cluster. See [Installing Tekton Pipelines](https://github.com/tektoncd/pipeline/blob/main/docs/install.md).
- Optionally, install Tekton Triggers. See [Installing Tekton Triggers](https://github.com/tektoncd/triggers/blob/main/docs/install.md).

## Which version should I use
### Supported Tekton Pipelines and Tekton Triggers versions

Every Tekton Dashboard release is tested against specific Tekton Pipelines and Tekton Triggers versions.
See the [docs on the main page](./README.md) to find the Tekton Dashboard version that suits your needs.

Pay attention to annoucements like **deprecated versions** and/or **security related recommendations** when choosing the version you want to install.
Each Tekton Dashboard release is tested against specific Tekton Pipelines and Tekton Triggers versions. See the Tekton Dashboard release notes for details of the supported versions.

## Installing Tekton Dashboard on Kubernetes

Expand Down
48 changes: 0 additions & 48 deletions docs/legacy-releases.md

This file was deleted.

88 changes: 88 additions & 0 deletions releases.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
# Tekton Dashboard Releases

## Release Frequency

Tekton Dashboard follows the Tekton community [release policy][release-policy]
as follows:

- Versions are numbered according to semantic versioning: `vX.Y.Z`
- A new release is produced on a monthly basis
- Four releases a year are chosen for [long term support (LTS)](https://github.com/tektoncd/community/blob/main/releases.md#support-policy).
All remaining releases are supported for approximately 1 month (until the next
release is produced)
- LTS releases take place in January, April, July and October every year
- The first Tekton Dashboard LTS release will be **v0.30.0** in October 2022
- Releases happen towards the middle of the month, between the 13th and the
20th, depending on week-ends and readiness

Tekton Dashboard produces nightly builds, publicly available on
`gcr.io/tekton-nightly`.

### Transition Process

Before release v0.30 Tekton Dashboard has worked on the basis of an undocumented
support period of four months, which will be maintained for the releases between
v0.27 and v0.29.

## Release Process

Tekton Pipeline releases are made of YAML manifests and container images.
Manifests are published to cloud object-storage as well as
[GitHub][tekton-dashboard-releases]. Container images are signed by
[Sigstore][sigstore] via [Tekton Chains][tekton-chains]; signatures can be
verified through the [public key][chains-public-key] hosted by the Tekton Chains
project.

Further documentation available:

- The Tekton Dashboard [release process][release-docs]
- [Installing Tekton Dashboard][dashboard-installation]
- Standard for [release notes][release-notes-standards]

## Releases

### v0.29

- **Latest Release**: [v0.29.2][v0-29-2] (2022-09-15) ([docs][v0-29-2-docs])
- **Initial Release**: [v0.29.0][v0-29-0] (2022-09-13)
- **End of Life**: 2023-01-13
- **Patch Releases**: [v0.29.0][v0-29-0], [v0.29.1][v0-29-1], [v0.29.2][v0-29-2]

### v0.28

- **Latest Release**: [v0.28.0][v0-28-0] (2022-07-12) ([docs][v0-28-0-docs])
- **Initial Release**: [v0.28.0][v0-28-0] (2022-07-12)
- **End of Life**: 2022-11-12
- **Patch Releases**: [v0.28.0][v0-28-0]

### v0.27

- **Latest Release**: [v0.27.0][v0-27-0] (2022-06-16) ([docs][v0-27-0-docs])
- **Initial Release**: [v0.27.0][v0-27-0] (2022-06-16)
- **End of Life**: 2022-10-16
- **Patch Releases**: [v0.27.0][v0-27-0]

## End of Life Releases

Older releases are EOL and available on [GitHub][tekton-dashboard-releases].


[release-policy]: https://github.com/tektoncd/community/blob/main/releases.md
[sigstore]: https://sigstore.dev
[tekton-chains]: https://github.com/tektoncd/chains
[tekton-dashboard-releases]: https://github.com/tektoncd/dashboard/releases
[chains-public-key]: https://github.com/tektoncd/chains/blob/main/tekton.pub
[release-docs]: tekton
[dashboard-installation]: docs/install.md
[release-notes-standards]:
https://github.com/tektoncd/community/blob/main/standards.md#release-notes

[v0-29-2]: https://github.com/tektoncd/dashboard/releases/tag/v0.29.2
[v0-29-1]: https://github.com/tektoncd/dashboard/releases/tag/v0.29.1
[v0-29-0]: https://github.com/tektoncd/dashboard/releases/tag/v0.29.0
[v0-28-0]: https://github.com/tektoncd/dashboard/releases/tag/v0.28.0
[v0-27-0]: https://github.com/tektoncd/dashboard/releases/tag/v0.27.0

[v0-29-2-docs]: https://github.com/tektoncd/dashboard/tree/v0.29.2/docs#tekton-dashboard
[v0-28-0-docs]: https://github.com/tektoncd/dashboard/tree/v0.28.0/docs#tekton-dashboard
[v0-27-0-docs]: https://github.com/tektoncd/dashboard/tree/v0.27.0/docs#tekton-dashboard
20 changes: 18 additions & 2 deletions tekton/release-cheat-sheet.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,11 +96,27 @@ Creating the release announcement is currently a manual process but will be auto

1. Publish the GitHub release once all notes are correct and in order.

1. Create a branch for the release named `release-v<version number>x`, e.g. [`release-v0.28.x`](https://github.com/tektoncd/dashboard/tree/release-v0.28.x)
and push it to the repo https://github.com/tektoncd/dashboard.
(This can be done on the Github UI.)
Make sure to fetch the commit specified in `TEKTON_RELEASE_GIT_SHA` to create the released branch.

## Post-release tasks

1. Edit `README.md` on `main` branch, add entry to docs table with latest release links.
1. If the release requires a new minimum version of Kubernetes,
edit `install.md` on the `main` branch and add the new requirement in the
"Pre-requisites" section

1. Edit `releases.md` on the `main` branch, add an entry for the release.
- In case of a patch release, replace the latest release with the new one,
including links to docs and examples. Append the new release to the list
of patch releases as well.
- In case of a minor or major release, add a new entry for the
release, including links to docs
- Check if any release is EOL, if so move it to the "End of Life Releases"
section

1. Push & make PR for updated `README.md`
1. Push & make PR for updated `releases.md` and `install.md`

1. Test the release that you just made against your own cluster (note `--context my-dev-cluster`):

Expand Down