Merge pull request #107 from vdice/ci/checksums

Author: radu-matei

.github/workflows/release.yml

@@ -12,6 +12,9 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
+      - name: set the release version (tag)
+        run: echo "RELEASE_VERSION=${GITHUB_REF/refs\/tags\//}" >> $GITHUB_ENV
+
       - name: Install Dependencies
         run: rustup target add wasm32-wasi
 
@@ -21,6 +24,11 @@ jobs:
       - name: Build bart
         run: make bart
 
+      - name: generate checksums
+        run: |
+          sha256sum target/wasm32-wasi/release/bartholomew.wasm > checksums-${{ env.RELEASE_VERSION }}.txt
+          sha256sum target/release/bart >> checksums-${{ env.RELEASE_VERSION }}.txt
+
       - name: Create release
         uses: softprops/action-gh-release@v1
         with:
@@ -29,3 +37,4 @@ jobs:
           files: |
             target/wasm32-wasi/release/bartholomew.wasm
             target/release/bart
+            checksums-${{ env.RELEASE_VERSION }}.txt

release-process.md

@@ -5,12 +5,11 @@ To cut a release of Bartholomew, you will need to do the following:
 1. Create a pull request that changes the version number for your new version (e.g. 1.2.2 becomes 1.2.3)
     - `Cargo.toml` and `bart/Cargo.toml` are the most important places to make this change
     - Check the docs for hard-coded version strings
-2. Merge the PR created in #1 (Such PRs are still required to get approvals, so make sure you get signoff on the PR)
-3. Create a new tag with a `v` and then the version number (`v1.2.3`)
-4. Push the tag up to `main` on GitHub
+1. Merge the PR created in #1 (Such PRs are still required to get approvals, so make sure you get signoff on the PR)
+1. Create a new tag with a `v` and then the version number (`v1.2.3`)
+1. Push the tag to origin (eg `git push origin v1.2.3`)
     - This will trigger a release build
-5. Build WebAssembly binary, `batholomew.wasm`
-6. Generate SHAs with `shasum -a 256 bartholomew.wasm ` or a similar command
-7. Go to the GitHub [tags page](https://github.com/fermyon/bartholomew/releases) and create a release, adding release notes, and uploading `bartholomew.wasm`. The SHAs should go in the release notes.
+    - The release build will attach the `bartholomew.wasm`, `bart` CLI and checksums file to the GitHub release
+    - The release notes will be auto-generated, but you can edit as needed, for instance to alert about breaking changes or other notable items
 
 At this point, you can just verify that all things are good.