Skip to content

Commit

Permalink
Document Space ROS release process (#24)
Browse files Browse the repository at this point in the history
  • Loading branch information
Bckempa committed May 1, 2024
1 parent dd8cff4 commit 9542545
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 0 deletions.
1 change: 1 addition & 0 deletions source/How-To-Guides.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
32 changes: 32 additions & 0 deletions source/How-To-Guides/Releasing-Space-ROS.rst
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 9542545

Please sign in to comment.