From ca1b1c005c5232e75f5a4a55599d67411623b2ea Mon Sep 17 00:00:00 2001 From: stevenhorsman Date: Thu, 29 Jun 2023 16:45:23 +0100 Subject: [PATCH] release-check-list: Formatting - Try and improve the formatting to be it easier to read/understand Signed-off-by: stevenhorsman --- .github/ISSUE_TEMPLATE/release-check-list.md | 140 +++++++++---------- 1 file changed, 70 insertions(+), 70 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/release-check-list.md b/.github/ISSUE_TEMPLATE/release-check-list.md index da1b19f..8efacac 100644 --- a/.github/ISSUE_TEMPLATE/release-check-list.md +++ b/.github/ISSUE_TEMPLATE/release-check-list.md @@ -10,128 +10,128 @@ assignees: '' ## Code freeze -- [ ] - 1. Update image-rs to use the latest commit from ocicrypt-rs +1. - [ ] Update image-rs to use the latest commit from ocicrypt-rs - * https://github.com/confidential-containers/image-rs/blob/main/Cargo.toml - * Change the revision - * Run `cargo update -p ocicrypt-rs` + * https://github.com/confidential-containers/image-rs/blob/main/Cargo.toml + * Change the revision + * Run `cargo update -p ocicrypt-rs` -- [ ] - 2. Update image-rs to use the latest commit from attestation-agent +2. - [ ] Update image-rs to use the latest commit from attestation-agent - * https://github.com/confidential-containers/image-rs/blob/main/Cargo.toml - * Change the revision - * Run `cargo update -p attestation_agent` + * https://github.com/confidential-containers/image-rs/blob/main/Cargo.toml + * Change the revision + * Run `cargo update -p attestation_agent` -- [ ] - 3. Update Enclave CC to use the latest commit from image-rs +3. - [ ] Update Enclave CC to use the latest commit from image-rs - * https://github.com/confidential-containers/enclave-cc/blob/main/src/enclave-agent/Cargo.toml - * Change the revision - * Run `cargo update -p image-rs` + * https://github.com/confidential-containers/enclave-cc/blob/main/src/enclave-agent/Cargo.toml + * Change the revision + * Run `cargo update -p image-rs` Note that you can point to your own fork here, so you don't actually do changes in the other projects before making sure this step works as expected. -- [ ] - 4. Update Kata Containers to use the latest commit from image-rs, attestation-agent and td-shim +4. - [ ] Update Kata Containers to use the latest commit from image-rs, attestation-agent and td-shim - * image-rs - * https://github.com/kata-containers/kata-containers/blob/CCv0/src/agent/Cargo.toml - * Change the revision - * Run `cargo update -p image-rs` + * image-rs + * https://github.com/kata-containers/kata-containers/blob/CCv0/src/agent/Cargo.toml + * Change the revision + * Run `cargo update -p image-rs` Note that you can point to your own fork here, so you don't actually do changes in the other projects before making sure this step works as expected. - * attestation-agent and td-shim - * https://github.com/kata-containers/kata-containers/blob/CCv0/versions.yaml - * Change the version + * attestation-agent and td-shim + * https://github.com/kata-containers/kata-containers/blob/CCv0/versions.yaml + * Change the version -- [ ] - 5. Wait for kata-runtime-payload-ci to be successfully built - * After the previous PR is merged wait for the kata-runtime-payload-ci (https://github.com/kata-containers/kata-containers/actions/workflows/cc-payload-after-push.yaml) has completed, so the latest kata-runtime-payload-ci contains the changes +5. - [ ] Wait for kata-runtime-payload-ci to be successfully built + * After the previous PR is merged wait for the kata-runtime-payload-ci (https://github.com/kata-containers/kata-containers/actions/workflows/cc-payload-after-push.yaml) has completed, so the latest kata-runtime-payload-ci contains the changes -- [ ] - 6. Check if there are new changes in the pre install payload script +6. - [ ] Check if there are new changes in the pre install payload script - * https://github.com/confidential-containers/operator/tree/main/install/pre-install-payload - * The last commit there must match what's in the following files as preInstall / postUninstall image - * Enclave CC: https://github.com/confidential-containers/operator/blob/main/config/samples/enclave-cc/base/ccruntime-enclave-cc.yaml - * Kata Containers: - Note that for Kata Containers, we're looking for the newTag, below the quay.io/confidential-containers/container-engine-for-cc-payload image - * default: https://github.com/confidential-containers/operator/blob/main/config/samples/ccruntime/default/kustomization.yaml - -- [ ] - 7. Ensure the Operator is using the latest CI builds and that the Operator tests are passsing - - * Enclave CC: - * SIM: https://github.com/confidential-containers/operator/blob/main/config/samples/enclave-cc/sim/kustomization.yaml - * HW: https://github.com/confidential-containers/operator/blob/main/config/samples/enclave-cc/base/ccruntime-enclave-cc.yaml - * Note that we need the quay.io/confidential-containers/runtime-payload-ci registry and enclave-cc-{SIM,HW}-latest tags + * https://github.com/confidential-containers/operator/tree/main/install/pre-install-payload + * The last commit there must match what's in the following files as preInstall / postUninstall image + * Enclave CC: https://github.com/confidential-containers/operator/blob/main/config/samples/enclave-cc/base/ccruntime-enclave-cc.yaml * Kata Containers: + Note that for Kata Containers, we're looking for the newTag, below the quay.io/confidential-containers/container-engine-for-cc-payload image * default: https://github.com/confidential-containers/operator/blob/main/config/samples/ccruntime/default/kustomization.yaml - * peer-pods: https://github.com/confidential-containers/operator/blob/main/config/samples/ccruntime/peer-pods/kustomization.yaml + +7. - [ ] Ensure the Operator is using the latest CI builds and that the Operator tests are passsing + + * Enclave CC: + * SIM: https://github.com/confidential-containers/operator/blob/main/config/samples/enclave-cc/sim/kustomization.yaml + * HW: https://github.com/confidential-containers/operator/blob/main/config/samples/enclave-cc/base/ccruntime-enclave-cc.yaml + * Note that we need the quay.io/confidential-containers/runtime-payload-ci registry and enclave-cc-{SIM,HW}-latest tags + * Kata Containers: + * default: https://github.com/confidential-containers/operator/blob/main/config/samples/ccruntime/default/kustomization.yaml + * peer-pods: https://github.com/confidential-containers/operator/blob/main/config/samples/ccruntime/peer-pods/kustomization.yaml Note that we need the quay.io/confidential-containers/runtime-payload-ci registry and kata-containers-latest tag -- [ ] - 8. Update peer-pods with latest commits of kata-containers and attestation-agent and test it, following the [release candidate testing process](https://github.com/confidential-containers/cloud-api-adaptor/blob/main/docs/Release-Process.md#release-candidate-testing) +8. - [ ] Update peer-pods with latest commits of kata-containers and attestation-agent and test it, following the [release candidate testing process](https://github.com/confidential-containers/cloud-api-adaptor/blob/main/docs/Release-Process.md#release-candidate-testing) -- [ ] - 9. Cut an ocicrypt-rs v release, if changes happened in the project +9. - [ ] Cut an ocicrypt-rs v release, if changes happened in the project -- [ ] - 10. Cut an attestation-agent v, if changes happened in the project +10. - [ ] Cut an attestation-agent v, if changes happened in the project -- [ ] - 11. Cut an attestation-service v and make images for AS and RVPS, if changes happened in the project. +11. - [ ] Cut an attestation-service v and make images for AS and RVPS, if changes happened in the project. * https://github.com/confidential-containers/attestation-service * Cut a release (AS/RVPS images will be automatically built triggered by release) -- [ ] - 12. Update kbs to use the latest commit from attestation-service, cut a release and make image +12. - [ ] Update kbs to use the latest commit from attestation-service, cut a release and make image * https://github.com/confidential-containers/kbs/blob/main/src/api_server/Cargo.toml * Change the revision for the following crates (both use `v`) - * `as-types` - * `attestation-service` + * `as-types` + * `attestation-service` * Cut a release (kbs image will be automatically built triggered by release) -- [ ] - 13. Cut an image-rs v release, using the latest release of: +13. - [ ] Cut an image-rs v release, using the latest release of: - * ocicrypt-rs (redo step 1, but now using v) - * attestation-agent (redo step 2, but now using v) + * ocicrypt-rs (redo step 1, but now using v) + * attestation-agent (redo step 2, but now using v) -- [ ] - 14. Cut a td-shim v release, if changes happened in the project +14. - [ ] Cut a td-shim v release, if changes happened in the project -- [ ] - 15. Update Enclave CC to use the released version of image-rs +15. - [ ] Update Enclave CC to use the released version of image-rs - * redo step 3, but now using v + * redo step 3, but now using v -- [ ] - 16. Update Kata Containers to the latest released version of: +16. - [ ] Update Kata Containers to the latest released version of: - * image-rs (redo step 4, but now using the v) - * attestation-agent (redo step 5, but now using the v) - * td-shim (redo step 6, but now using the v) + * image-rs (redo step 4, but now using the v) + * attestation-agent (redo step 5, but now using the v) + * td-shim (redo step 6, but now using the v) -- [ ] - 17. Update the operator to use the images generated from the latest commit of both Kata Containers and Enclave CC +17. - [ ] Update the operator to use the images generated from the latest commit of both Kata Containers and Enclave CC - * redo step 8, but now targetting the latest payload image generated for Kata Containers and Enclave CC + * redo step 8, but now targetting the latest payload image generated for Kata Containers and Enclave CC -- [ ] - 19. Make sure all the operator tests are passing +19. - [ ] Make sure all the operator tests are passing -- [ ] - 19. Cut an Enclave CC release +19. - [ ] Cut an Enclave CC release -- [ ] - 20. Add a new Kata Containers tag +20. - [ ] Add a new Kata Containers tag -- [ ] - 21. Wait for release kata-runtime-payload to be successfully built - * After the Kata tag is created wait for (https://github.com/kata-containers/kata-containers/actions/workflows/cc-payload.yaml) to be successfully completed, so the latest commit kata-runtime-payload for the release is created +21. - [ ] Wait for release kata-runtime-payload to be successfully built + * After the Kata tag is created wait for (https://github.com/kata-containers/kata-containers/actions/workflows/cc-payload.yaml) to be successfully completed, so the latest commit kata-runtime-payload for the release is created -- [ ] - 22. Update peer pods to use the release versions and then cut a release following the [documented flow](https://github.com/confidential-containers/cloud-api-adaptor/blob/main/docs/Release-Process.md#cutting-releases) +22. - [ ] Update peer pods to use the release versions and then cut a release following the [documented flow](https://github.com/confidential-containers/cloud-api-adaptor/blob/main/docs/Release-Process.md#cutting-releases) ## Release -- [ ] - 23. Update the operator to use the release tags coming from Enclave CC and Kata Containers +23. - [ ] Update the operator to use the release tags coming from Enclave CC and Kata Containers - * redo step 8, but now targeting the latest release of the payload image generated for Kata Containers eand Enclave CC + * redo step 8, but now targeting the latest release of the payload image generated for Kata Containers eand Enclave CC -- [ ] - 24. Update the Operator version +24. - [ ] Update the Operator version - * https://github.com/confidential-containers/operator/blob/main/config/release/kustomization.yaml#L7 + * https://github.com/confidential-containers/operator/blob/main/config/release/kustomization.yaml#L7 -- [ ] - 25. Cut an operator release +25. - [ ] Cut an operator release -- [ ] - 26. Make sure to update the release notes +26. - [ ] Make sure to update the release notes - * https://github.com/confidential-containers/documentation/tree/main/releases/v.md + * https://github.com/confidential-containers/documentation/tree/main/releases/v.md -- [ ] - 27. Poke Wainer Moschetta (@wainersm) to update the release to the OperatorHub +27. - [ ] Poke Wainer Moschetta (@wainersm) to update the release to the OperatorHub