mirror of https://github.com/knative/docs.git
59 lines
2.1 KiB
Markdown
59 lines
2.1 KiB
Markdown
# Releasing a new version of the Knative documentation
|
|
|
|
This document describes how to perform a docs release. In general, this should
|
|
be done by one of the release managers in the list at
|
|
https://github.com/knative/release.
|
|
|
|
To release a new version of the docs you must:
|
|
|
|
1. [Check dependencies](#check-dependencies)
|
|
1. [Create a release branch](#create-a-release-branch)
|
|
1. [Generate the new docs version](#generate-the-new-docs-version)
|
|
|
|
## Check dependencies
|
|
|
|
You cannot release a new version of the docs until the Knative components have
|
|
built their new release.
|
|
This is because the website references these releases in various locations.
|
|
|
|
Check the following components for the new release:
|
|
|
|
* [client](https://github.com/knative/client/releases/)
|
|
* [eventing](https://github.com/knative/eventing/releases/)
|
|
* [operator](https://github.com/knative/operator/releases/)
|
|
* [serving](https://github.com/knative/serving/releases/)
|
|
|
|
## Create a release branch
|
|
|
|
1. Check on the `#docs` Slack channel to make sure the release is ready.
|
|
_In the future, we should automate this so the check isn't needed._
|
|
|
|
1. Using the GitHub UI, create a `release-X.Y` branch based on `main`.
|
|
|
|
|
|
|
|
## Generate the new docs version
|
|
|
|
To generate the new version of the docs, you must update the [`hack/build.sh`](../hack/build.sh)
|
|
script in the main branch to reference the new release.
|
|
|
|
We keep the last 4 releases available per [our support window](https://github.com/knative/community/blob/main/mechanics/RELEASE-VERSIONING-PRINCIPLES.md#knative-community-support-window-principle).
|
|
|
|
To generate the new docs version:
|
|
|
|
1. In `hack/build.sh` on the main branch, update `VERSIONS` and `RELEASE_BRANCHES`
|
|
to include the new version, and remove the oldest. Order matters, most recent first.
|
|
|
|
For example:
|
|
|
|
```
|
|
VERSIONS=("1.2" "1.1" "1.0" "0.26")
|
|
RELEASE_BRANCHES=("knative-v1.2.0" "knative-v1.1.0" "knative-v1.0.0" "v0.26.0")
|
|
```
|
|
|
|
1. PR the result to main.
|
|
|
|
## How GitHub and Netlify are hooked up
|
|
|
|
TODO: add information about how the docs are built and served using Netlify
|