diff --git a/Release-Process.md b/Release-Process.md index 30859ad..33e41ec 100644 --- a/Release-Process.md +++ b/Release-Process.md @@ -1,3 +1,5 @@ +These operations are performed on an Ubuntu 22.04 x86_64 PC. You'll need sudo access and plenty of hard disk space. + # Verify that your username and email are configured properly ``` # To see the current configuration @@ -30,14 +32,14 @@ Change `piscsi_patch_version` to the release number for that month. Typically, t Check that your changes are syntactically correct ``` -cd cpp && make all -j4 +make all -j4 -C ./cpp ``` # Commit the version and create the tag ``` -git commit -m "Update revision number for release" ./cpp/shared/rascsi_version.cpp +git commit -m "Update revision number for release" ./cpp/shared/piscsi_version.cpp # Note that each of the tag name's numbers should be 2 characters # Ex: the tag name for release 23.2.1 would be "v23.02.01 -git tag -a v23.04.01 -m "PiSCSI version 23.02.01" +git tag -a v23.04.01 -m "PiSCSI version 23.04.01" git push origin v23.04.01 ``` @@ -54,31 +56,43 @@ Change `piscsi_patch_version` to -1. This is a flag that this is a development v Check that your changes are syntactically correct ``` -cd cpp && make all -j4 +make all -j4 -C ./cpp # If this succeeds, commit to the develop branch git commit -m "Update version for next development version" cpp/shared/piscsi_version.cpp git push origin develop ``` -# Update master with the new release +# Update main with the new release ``` -git checkout master +git checkout main git pull # Merge in the new tag git merge v23.04.01 # Check that there are no conflicts (there shouldn't be) git status -git push origin master +git push origin main ``` # Draft the release notes -Navigate to https://github.com/PiSCSI/piscsi/releases and click Draft New Release +Navigate to https://github.com/PiSCSI/piscsi/releases and click Draft New Release. -Choose the new tag you just created. The release name should be **<> <> Release**. Example: [February 2023 Release](https://github.com/PiSCSI/piscsi/releases/tag/v23.02.01) +Choose the new tag you just created. +![image](https://user-images.githubusercontent.com/34318535/233813523-5162aa1d-4cd0-4c51-ad88-7d4c8797ae35.png) + +The release name should be **<> <> Release**. Example: [February 2023 Release](https://github.com/PiSCSI/piscsi/releases/tag/v23.02.01) + +Set the previous release, then generate the release notes + +![image](https://user-images.githubusercontent.com/34318535/233813583-ea092204-d1d8-492e-9694-f042e3c9af9a.png) + +Set this as a pre-release, then publish + +![image](https://user-images.githubusercontent.com/34318535/233813637-3fcfbb51-33de-4e44-8b72-5f1a5aa77feb.png) + +# Review the release notes +Have the development team review the release notes as appropriate. Copy the first few sections of the previous release notes and update as appropriate. Re-generate the translation statistics, etc. -Tag this as a pre-release! - # Create the RPi Image ``` cd ~