Merge pull request #165 from Chia-Network/rc-workflow-in-apt

ci: add rc releases to apt repo

.github/workflows/build.yaml

@@ -304,7 +304,7 @@ jobs:
           zip -r core-registry-cadt-macos-binary-x64-${{ steps.tag-name.outputs.TAGNAME }}.zip core-registry-cadt-macos-x64
 
       # RC release should not be set as latest
-      - name: Decide if release should be set as latest
+      - name: Decide if release should be set as latest and set glue project
         id: is_latest
         shell: bash
         run: |
@@ -316,14 +316,17 @@ jobs:
             echo "release candidate tag matched"
             IS_LATEST='false'
             IS_PRERELEASE='true'
+            GLUE_PROJECT='climate-tokenization-test'
           else
             echo "main branch release matched"
             IS_LATEST='true'
             IS_PRERELEASE='false'
+            GLUE_PROJECT='climate-tokenization'
           fi
 
           echo "IS_LATEST=${IS_LATEST}" >> "$GITHUB_OUTPUT"
           echo "IS_PRERELEASE=${IS_PRERELEASE}" >> "$GITHUB_OUTPUT"
+          echo "GLUE_PROJECT=${GLUE_PROJECT}" >> "$GITHUB_OUTPUT"
 
       - name: Release
         uses: softprops/action-gh-release@v2
@@ -350,5 +353,5 @@ jobs:
         with:
           json_data: '{"climate_tokenization_repo":"${{ steps.repo-name.outputs.REPO_NAME }}","application_name":"[\"core-registry-cadt\"]","release_version":"${{ steps.tag-name.outputs.TAGNAME }}","add_debian_version":"true","arm64":"available"}'
           glue_url: ${{ secrets.GLUE_API_URL }}
-          glue_project: "climate-tokenization"
+          glue_project: "${{steps.is_latest.outputs.GLUE_PROJECT}}"
           glue_path: "trigger"

README.md

@@ -119,6 +119,26 @@ journalctl -u cadt@<USERNAME> -f
 (ctrl+c to exit)
 ```
 
+### Pre-release Versions
+
+Experimental code is released with a "release candidate" naming convention and can be found on the [releases](/releases) page with `-rc` in the version number. Not all of the release candidates will be stable and caution should be used.  
+
+Release candidates can be installed via `apt` using the instructions (above)[#debian-based-linux-distros-ubuntu-mint-etc] except replace step 3 with the following:
+
+```
+echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/chia.gpg] https://repo.chia.net/climate-tokenization-test/debian/ stable main" | sudo tee /etc/apt/sources.list.d/climate-tokenization-test.list > /dev/null
+```
+
+If both the stable and release-candidate repos are added, `apt` can switch between versions installed using by appending `=<version-number>` to the install command:
+
+```
+apt install climate-tokenization-engine=1.3.22
+apt install climate-tokenization-engine=1.3.23-rc7
+apt install climate-tokenization-engine=1.2.1
+```
+
+Without specifying the version number, `apt` will install the latest release candidate if it exists, which might not always be desired. 
+
 ### Installation from Source
 
 You'll need: