mirror of https://github.com/istio/istio.io.git
Update release procedures.
This commit is contained in:
mtail
parent
48c8a28968
commit
d53d15f272
105
README.md
105
README.md
|
|
@ -58,7 +58,7 @@ are included on archive.istio.io is determined by the `TOBUILD` variable in this
|
|||
Checking in updates to the master branch will automatically update preliminary.istio.io, and will only be reflected on
|
||||
istio.io the next time a release is created, which can be several weeks in the future. If you'd like some changes to be
|
||||
immediately reflected on istio.io, you need to check your changes both to the master branch and to the
|
||||
current release branch (named release-XXX such as release-0.7).
|
||||
current release branch (named release-XXX such as release-1.4).
|
||||
|
||||
This process can be taken care of automatically by our infrastructure. If you submit a PR
|
||||
to the master branch and annotate the PR with the `actions/merge-to-release-branch` label,
|
||||
|
|
@ -67,90 +67,107 @@ then as soon as your PR is merged into master, it will be merged into the curren
|
|||
### Creating a version
|
||||
|
||||
Here are the steps necessary to create a new documentation version. Let's assume the current
|
||||
version of Istio is 0.6 and you wish to introduce 0.7 which has been under development.
|
||||
version of Istio is 1.3 and you wish to introduce 1.4 which has been under development.
|
||||
|
||||
#### Creating the release branch
|
||||
#### When Istio source code is branched
|
||||
|
||||
1. Switch to the istio/istio.io repo and make sure everything is up to date.
|
||||
The documentation repo pulls content from the Istio source repos for inclusion in the published site.
|
||||
When the source repos are branched in preparation for a release, a few changes are needed in the
|
||||
documentation repo to track this:
|
||||
|
||||
1. Switch to the **master** branch of the istio/istio.io repo and make sure everything is up to date.
|
||||
|
||||
1. Edit the file `Makefile.core.mk` and change the `SOURCE_BRANCH_NAME` variable to the
|
||||
name of the newly created source branches (in this case `release-1.4`).
|
||||
|
||||
1. Edit the file `data/args.yml` and set the `source_branch_name` field to the name of the newly created source
|
||||
branches (in this case `release-1.4`).
|
||||
|
||||
1. Run `make update_all` in order to retrieve the latest material from the source repositories.
|
||||
|
||||
1. Commit the previous edits to your local git repo and push your **master** branch to GitHub.
|
||||
|
||||
#### On the day of the release
|
||||
|
||||
##### Creating the release branch
|
||||
|
||||
The day of a major Istio release, assuming you've previously done the steps from the above section, you need to:
|
||||
|
||||
1. Switch to the **master** branch of the istio/istio.io repo and make sure everything is up to date.
|
||||
|
||||
1. Edit the file `scripts/build_archive_site.sh` and add the new archive version
|
||||
(in this case release-0.6) to the `TOBUILD` variable.
|
||||
(in this case `release-1.3`) to the `TOBUILD` variable.
|
||||
|
||||
1. Edit the file `data/versions.yml`. Set the `preliminary` field to the next Istio release
|
||||
("0.8") and the `main` field to the current release ("0.7").
|
||||
(in this case `1.5`) and the `main` field to the current release (in this case `1.4`).
|
||||
|
||||
1. Commit the previous edits to your local git repo.
|
||||
1. Commit the previous edits to your local git repo and push your **master** branch to GitHub.
|
||||
|
||||
1. Create a new release branch off of master, named as release-*major*.*minor*, which in this case would be
|
||||
release-0.7. There is one such branch for every release.
|
||||
1. Create a new release branch off of master, named as release-**major**.**minor** (in this case `release-1.4`). There is one
|
||||
such branch for every release.
|
||||
|
||||
1. In the **release** branch you created, edit the file `data/args.yml`. Set the `preliminary` field to `false`
|
||||
and the `source_branch_name` and `doc_branch_name` fields to the name of the branch, in this case release-0.7.
|
||||
1. Edit the file `data/args.yml`. Set the `preliminary` field to `false`
|
||||
and the the `doc_branch_name` field to the name of the release branch (in this case `release-1.4`).
|
||||
|
||||
1. In the **release** branch you created, edit the file `scripts/grab_reference_docs.sh`. Update the branch
|
||||
name for `istio.git`, `api.git`, and `operator.git` to point to the release branch. In this case release-0.7.
|
||||
|
||||
1. In the **release** branch you created, run `make update_ref_docs` in order to get the latest reference docs.
|
||||
|
||||
1. Commit the previous edit to your local git repo and push your **release** branch to GitHub.
|
||||
|
||||
#### Updating preliminary.istio.io
|
||||
|
||||
1. In the **master** branch, edit the file `data/args.yml`. Set the `version` and `full_version` fields to have the version
|
||||
of the next Istio release, and `previous_version` to be the version of the previous release. In this case, you would set the fields to
|
||||
"0.8", "0.8.0", and "0.7" respectively.
|
||||
|
||||
1. In the **master** branch, edit the file `data/args.yml`. Set the
|
||||
`source_branch_name` and `doc_branch_name` fields to `master`.
|
||||
|
||||
1. In the **master** branch, edit the file `scripts/grab_reference_docs.sh`. Ensure the branch
|
||||
name for `istio.git`, `api.git`, and `operator.git` points to the master branch.
|
||||
|
||||
1. Run `make update_ref_docs` in order to get the latest reference docs.
|
||||
|
||||
1. Commit the previous edits to your local git repo and push the **master** branch to GitHub.
|
||||
|
||||
1. Wait a while (~2 minutes) and browse preliminary.istio.io to make sure everything looks good.
|
||||
1. Commit the previous edits to your local git repo and push your **release** branch to GitHub.
|
||||
|
||||
#### Updating istio.io
|
||||
|
||||
1. Go to the istio.io project on [Netlify](https://netlify.com)
|
||||
|
||||
1. Change the branch that is built from the previous release's branch to the new release branch, in this case release-0.7
|
||||
1. Change the branch that is built from the previous release's branch to the new release branch, in this case release-1.4
|
||||
|
||||
1. Select the option to trigger an immediate rebuild and redeployment.
|
||||
|
||||
1. Once deployment is done, browse istio.io and make sure everything looks good.
|
||||
|
||||
#### Updating archive.istio.io
|
||||
##### Updating archive.istio.io
|
||||
|
||||
1. Go to the [Google Custom Search Engine](https://cse.google.com) and do the following:
|
||||
|
||||
- Download the archive.istio.io CSE context file from the Advanced tab.
|
||||
|
||||
- Add a new FacetItem at the top of the file containing the previous release's version number. In
|
||||
this case, this would be "V0.6".
|
||||
this case, this would be "V1.3".
|
||||
|
||||
- Upload the updated CSE context file to the site.
|
||||
|
||||
- In the Setup section, add a new site that covers the previous release's archive directory. In this
|
||||
case, the site URL would be archive.istio.io/v0.6/*. Set the label of this site to the name of the
|
||||
facet item created above (V0.6 in this case).
|
||||
case, the site URL would be archive.istio.io/v1.3/*. Set the label of this site to the name of the
|
||||
facet item created above (V1.3 in this case).
|
||||
|
||||
1. In the **previous release's** branch (in this case release-0.6), edit the file `data/args.yml`. Set the
|
||||
1. In the **previous release's** branch (in this case `release-1.3`), edit the file `data/args.yml`. Set the
|
||||
`archive` field to true and the `archive_date` field to the current date.
|
||||
|
||||
1. In the **previous release's** branch (in this case release-0.6), edit the file `config.toml`. Set the
|
||||
1. In the **previous release's** branch (in this case `release-1.3`), edit the file `config.toml`. Set the
|
||||
`disableAliases` field to `false`.
|
||||
|
||||
1. Commit the previous edits to your local git repo and push the **previous release's** branch to GitHub.
|
||||
|
||||
1. In the **archive** branch, rebase the branch to have all changes from the current release. In this case,
|
||||
all changes from the release-0.7 branch.
|
||||
all changes from the `release-1.4` branch.
|
||||
|
||||
1. Commit the previous edits to your local git repo and push the **archive** branch to GitHub.
|
||||
|
||||
1. Wait a while (~15 minutes) and browse archive.istio.io to make sure everything looks good.
|
||||
1. Wait a while (~20 minutes) and browse archive.istio.io to make sure everything looks good.
|
||||
|
||||
##### Updating preliminary.istio.io
|
||||
|
||||
1. In the **master** branch, edit the file `data/args.yml`. Set the `version` and `full_version` fields to have the version
|
||||
of the next Istio release, and `previous_version` to be the version of the previous release. In this case, you would set the fields to
|
||||
"1.5", "1.5.0", and "1.4" respectively.
|
||||
|
||||
1. In the **master** branch, edit the file `data/args.yml`. Set the
|
||||
`source_branch_name` and `doc_branch_name` fields to `master`.
|
||||
|
||||
1. In the **master** branch, edit the file `Makefile.core.mk`. Set the variable `SOURCE_BRANCH_NAKE` to
|
||||
`master`.
|
||||
|
||||
1. Run `make update_all` in order to retrieve the latest material from the source repositories.
|
||||
|
||||
1. Commit the previous edits to your local git repo and push the **master** branch to GitHub.
|
||||
|
||||
1. Wait a while (~5 minutes) and browse preliminary.istio.io to make sure everything looks good.
|
||||
|
||||
### Creating a patch release
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue