From 986efc799a9be5ca70aba6d64a719cb78e4c67f9 Mon Sep 17 00:00:00 2001 From: Christian Berendt Date: Mon, 30 Oct 2023 21:55:02 +0100 Subject: [PATCH] Move some docs to osism.github.io (#1119) Signed-off-by: Christian Berendt --- doc/source/index.rst | 166 +------------------------------------------ 1 file changed, 2 insertions(+), 164 deletions(-) diff --git a/doc/source/index.rst b/doc/source/index.rst index 3f6ef5fb..4e3eb622 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -56,174 +56,12 @@ The documentation has been moved: https://osism.github.io/docs/guides/upgrade-gu How do we release? ================== -Currently we do a major release every 6 months. Minor releases we do when needed and -about every 2 weeks. - -In a minor release, only updates, bug fixes, etc. take place. There are also no major -upgrades of included components such as OpenStack, Keycloak or Ceph in a minor release. - -It is possible to jump from any minor version within a major version to higher minor -versions without any intervention. - -Deprecations, removals, etc. take place in a major release. New mandatory features are -also added in a major release. Upgrades of the included components can also take place -during a major release (e.g. OpenStack Xena -> OpenStack Yoga). - -It is possible to jump from the previous major version to the next major version. It may -be that manual intervention is necessary. For example, configuration parameters may need -to be added or services that no longer exist may need to be removed. - +The documentation has been moved: https://osism.github.io/docs/advanced-guides/developer-guide/#how-do-we-release How do you do a release? ======================== -Pre-release ------------ - -1. On all repositories that are used, check that the versions to be used have an - appropriate version tag (e.g. ``v0.20230308.0``). - - .. code-block:: none - - osism/ansible-collection-commons - osism/ansible-collection-services - osism/ansible-collection-validations - osism/ansible-defaults - osism/ansible-playbooks - osism/ansible-playbooks-manager - osism/cf-generics - osism/kolla-operations - osism/python-osism - -2. Copy the ``latest`` directory. The release to be created is used as the new name. - - .. code-block:: none - - latest -> 6.0.0b - -3. Remove all ``# renovate`` lines from the ``base.yml`` file. - -4. Remove all Ceph and OpenStack releases that should not be part of the pre-release. - There is only one OpenStack version and one Ceph version per (pre-)release. - -5. Ensure that the symlinks ``openstack.yml`` and ``ceph.yml`` point to the releases - to be used in this pre-release. - - .. code-block:: none - - base.yml - ceph-pacific.yml - ceph.yml -> ceph-pacific.yml - openstack-zed.yml - openstack.yml -> openstack-zed.yml - -6. Run ``src/prepare-release.py``. - - .. code-block:: none - - RELEASE=6.0.0b python3 src/prepare-release.py - -7. Do the steps from the ``Stable release`` starting from the 4th step. - -Stable release --------------- - -1. Copy the directory of the last pre-release or the previous stable release. - The release to be created is used as the new name. - - .. code-block:: none - - 5.0.0a -> 5.0.0b - 5.0.0b -> 5.0.0 - 5.0.0 -> 5.1.0 - 5.1.0 -> 5.2.0 - 5.2.0 -> 5.3.0 - -2. Change all necessary versions in the YAML files within the new directory. - In any case, the version of the pre-release or the version of the stable - release must be replaced by the release to be created. - -3. The release to be created is submitted as a pull request as usual and then - merged. - -4. Add a tag with the name of the new release to the listed repositories. - - .. code-block:: none - - osism/container-image-ceph-ansible - osism/container-image-inventory-reconciler - osism/container-image-osism-ansible - osism/container-images-kolla - -5. After completing the creation of the images in repository ``container-images-kolla``, - the file ``images.yml`` must be added to repository ``osism/sbom`` as - ``5.0.0/openstack.yml`` (instead of ``5.0.0``, the corresponding release is used). - The file is available as a build artefact of the ``Release container images`` action - on the created tag. - - Before the file is added, it is enhanced with the checksums of the images. The script - is available in the ``osism/sbom`` repository. - - .. code-block:: none - - VERSION=5.0.0 python3 scripts/add-image-checksum.py - -6. If ``5.0.0/openstack.yml`` is present in ``osism/sbom``, repository - ``osism/container-image-kolla-ansible`` can be tagged like the other - repositories before. - -7. Add the created SPDX files from the listed repositories to the ``osism/sbom`` repository. - The file are available as build artefacts of the ``Build container image`` action - on the created tags. - - .. code-block:: none - - osism/container-image-ceph-ansible - osism/container-image-kolla-ansible - osism/container-image-osism-ansible - -8. Add and run temporary CI jobs in ``osism/testbed`` that uses the pre-release. - - .. code-block:: yaml - - - job: - name: testbed-deploy-stable-next - parent: testbed-deploy - vars: - manager_version: "5.0.0a" - refstack: true - nodeset: testbed-orchestrator - - - job: - name: testbed-upgrade-stable-next - parent: testbed-deploy - vars: - manager_version: "4.2.0" - manager_version_next: "5.0.0a" - nodeset: testbed-orchestrator - -9. Test. Test. Test. - -10. Prepare a PR to change the stable version to the new stable version in the following Zuul jobs - in the ``osism/testbed`` repository. All tests there must pass successfully before the tag is - set on this repository in the next step. The temporary CI jobs (step 8) are removed again with - this PR. - - .. code-block:: none - - testbed-deploy-stable - testbed-update-stable - testbed-update-stable - testbed-upgrade-stable - -11. Add a new release notes file to ``doc/sorce/notes``. Generate the versions table with the - help of the ``release-table.py`` script in the ``osism/sbom`` repository. - -12. After all known issues are documented, a corresponding tag, e.g. ``v5.0.0``, is set on the - release repository. - -13. As the last of the release process, the previously prepared PR is merged on the - ``osism/testbed`` repository to change the stable version. +The documentation has been moved: https://osism.github.io/docs/advanced-guides/developer-guide/#how-do-you-do-a-release Questions & Answers ===================