knative
/
docs
mirror of https://github.com/knative/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

cut release 1.5, remove extra vars for build (#4999) 

* cut release 1.5, remove extra vars for build

Signed-off-by: Carlos Santana <csantana23@gmail.com>

* clean reference to removed variable

Signed-off-by: Carlos Santana <csantana23@gmail.com>

* making it a semver correct

Signed-off-by: Carlos Santana <csantana23@gmail.com>
This commit is contained in:
Carlos Santana 2022-06-03 17:38:53 -04:00 committed by GitHub
parent 5fa1d67ec6
commit c9c194ecee
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
contribute-to-docs/docs-release-process.md
View File

@ -41,18 +41,17 @@ We keep the last 4 releases available per [our support window](https://github.co
To generate the new docs version:
1. In `hack/build.sh` on the main branch, update `VERSIONS` and `RELEASE_BRANCHES`
1. In `hack/build.sh` on the main branch, update `VERSIONS`
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")
VERSIONS=("1.5" "1.4" "1.3" "1.2")
```
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
Netlify build is configure via [netlify.toml](../netlify.toml)

9
hack/build.sh
View File

@ -11,10 +11,9 @@ set -x
# Releasing a new version:
# 1) Make a release-NN branch as normal.
# 2) Update VERSIONS and RELEASE_BRANCHES below (on main) to include the new version, and remove the oldest
# 2) Update VERSIONS below (on main) to include the new version, and remove the oldest
# Order matters :-), Most recent first.
VERSIONS=("1.4" "1.3" "1.2" "1.1") # Docs version, results in the url e.g. knative.dev/docs-0.23/..
RELEASE_BRANCHES=("knative-v1.4.0" "knative-v1.3.0" "knative-v1.2.0" "v1.1.0") # Release version for serving/eventing yaml files and api references.
VERSIONS=("1.5" "1.4" "1.3" "1.2") # Docs version, results in the url e.g. knative.dev/docs-0.23/..
# 4) PR the result to main.
# 5) Party.
@ -41,7 +40,7 @@ else
git clone --depth 1 -b ${DOCS_BRANCHES[0]} https://github.com/${GIT_SLUG} "$TEMP/docs-$latest"
curl -f -L --show-error https://raw.githubusercontent.com/knative/serving/${DOCS_BRANCHES[0]}/docs/serving-api.md -s > "$TEMP/docs-$latest/docs/reference/api/serving-api.md"
curl -f -L --show-error https://raw.githubusercontent.com/knative/eventing/${DOCS_BRANCHES[0]}/docs/eventing-api.md -s > "$TEMP/docs-$latest/docs/reference/api/eventing-api.md"
pushd "$TEMP/docs-$latest"; KNATIVE_VERSION=${RELEASE_BRANCHES[0]//knative-} SAMPLES_BRANCH="${DOCS_BRANCHES[0]}" mkdocs build -d $SITE/docs; popd
pushd "$TEMP/docs-$latest"; KNATIVE_VERSION="${VERSIONS[0]}.0" SAMPLES_BRANCH="${DOCS_BRANCHES[0]}" mkdocs build -d $SITE/docs; popd
# Previous release branches release-$version to /v$version-docs
versionjson=""
@ -53,7 +52,7 @@ else
git clone --depth 1 -b ${DOCS_BRANCHES[$i+1]} https://github.com/${GIT_SLUG} "$TEMP/docs-$version"
curl -f -L --show-error https://raw.githubusercontent.com/knative/serving/${DOCS_BRANCHES[i+1]}/docs/serving-api.md -s > "$TEMP/docs-$version/docs/reference/api/serving-api.md"
curl -f -L --show-error https://raw.githubusercontent.com/knative/eventing/${DOCS_BRANCHES[i+1]}/docs/eventing-api.md -s > "$TEMP/docs-$version/docs/reference/api/eventing-api.md"
pushd "$TEMP/docs-$version"; KNATIVE_VERSION=${RELEASE_BRANCHES[i+1]//knative-} SAMPLES_BRANCH="${DOCS_BRANCHES[i+1]}" VERSION_WARNING=true mkdocs build -d "$SITE/v$version-docs"; popd
pushd "$TEMP/docs-$version"; KNATIVE_VERSION="${VERSIONS[i+1]}.0" SAMPLES_BRANCH="${DOCS_BRANCHES[i+1]}" VERSION_WARNING=true mkdocs build -d "$SITE/v$version-docs"; popd
done