Release Process for Envvars
IMPORTANT
For a new ocis release, some tasks are necessary to be done before releasing. Follow the steps carefully to avoid issues. Most of the docs related tasks are not part of the CI. With each step finished successfully, the next step can be started. Sometimes, due to last minute changes, steps need to be redone!
The following can be done at any time but it must be done latest when no envvar changes are made which is just before a new release gets finally tagged. The data generated must be part of the upcoming release and be merged before tagging/branching!
Ask the developers if envvars of this type have been changed (added or removed). See the Special Envvars documentation for more details on how to manage such a change.
- Run from the ocis root
make -C docs docs-generate
Drop any changes inenv_vars.yaml
! - Check if there is a change in the
extended-envars.yaml
output.
If so, process Extended Envvars - Fixing Changed Item. - When done, re-run the make command and check if the output of
./docs/services/_includes/adoc/extended_configvars.adoc
matches the expectations.
This is mandatory for a new release !
- Run from the ocis root
make -C docs docs-generate
Any changes inenv_vars.yaml
are now considered. - This file will most likely show changes and merging them is essential as base for added/removed or deprecated envvars. Note that this file will get additions/updates only, but things never get deleted automatically !!
Note that due to how the code is currently designed, things may get shifted around though no real changes have been introduced. - First, check if any alphabetic code names are present in the changes. See Introduce new Envvars.
- If so, create a new branch and replace them in the sourcing service with the actual semantic version (e.g.
releaseX
→7.2.0
) first. Note that ALL of major, minor and patch numbers must be present, including patch ==0
. - If all changes are applied, rerun
make -C docs docs-generate
and check if all changes are incorporated in the yaml file. - Create a PR and merge these changes, dont forget to rebase master afterwards…
- If so, create a new branch and replace them in the sourcing service with the actual semantic version (e.g.
- With a new branch, remove all envvars from the
env_vars.yaml
file manually that have formerly been deprecated and removed from the code. - Commit the changes and merge it.
Nowenv_vars.yaml
is up to date on the repo in master, next steps are based on this state!
- Create Envvar Deltas Between Versions files according the linked description.