From 9542545bada31002406c588e8a6a9cbdd11a3c00 Mon Sep 17 00:00:00 2001 From: Brian C S Kempa Date: Mon, 18 Dec 2023 01:48:03 -0800 Subject: [PATCH] Document Space ROS release process (#24) --- source/How-To-Guides.rst | 1 + source/How-To-Guides/Releasing-Space-ROS.rst | 32 ++++++++++++++++++++ 2 files changed, 33 insertions(+) create mode 100644 source/How-To-Guides/Releasing-Space-ROS.rst diff --git a/source/How-To-Guides.rst b/source/How-To-Guides.rst index bb98923..597059c 100644 --- a/source/How-To-Guides.rst +++ b/source/How-To-Guides.rst @@ -16,3 +16,4 @@ They contain succinct steps to help you accomplish important tasks quickly. How-To-Guides/Use-VSCode-With-Docker How-To-Guides/Use-The-Dashboard How-To-Guides/Use-Simulation-Assets + How-To-Guides/Releasing-Space-ROS diff --git a/source/How-To-Guides/Releasing-Space-ROS.rst b/source/How-To-Guides/Releasing-Space-ROS.rst new file mode 100644 index 0000000..5052f3a --- /dev/null +++ b/source/How-To-Guides/Releasing-Space-ROS.rst @@ -0,0 +1,32 @@ +Releasing Space ROS +=================== + +Before the release window +------------------------- + +- Determine the release tag of the form rosdist-year.month.point, for example ``humble-2024.01.0`` +- Open a new issue with a title of the form "year-month Release", for example "2024-01 Release" +- Create a milestone that matches the release tag in each repo under the Space ROS organization +- Create a new view in the Space ROS Project filtered by milestone + +During the release window +------------------------- + +- Tag issues intended for the release with the correct milestone +- Update issue status on the project view for the release + +At the end of the release window +-------------------------------- + +- Create release/distro branches on `docker`, `demos`, `simulation`, `docs`, and `process_sarif`. +- Update the .repos files to the new versions for the new distro sync. +- Re-run the tests, creating issues for any that failed. +- Docker images are already built but only tagged `latest`, must tag release as release name. +- Add announcements to Website, Docs, and Discourse +- Create next release milestone and tracking issue + +After release window +-------------------- + +- Open issues based on release experience +- Document lessons learned