GitHub actions updates (#162)

* Bump RabbitMQ and Erlang versions on Windows
* Move CI specific files to `.ci/`
* Only publish to NuGet when a GitHub release or pre-release is published

Bump actions resource versions

Update release process documentation

Co-authored-by: Gabriele Santomaggio <[email protected]>

tools/install.ps1 → .ci/install.ps1

@@ -4,7 +4,7 @@ Set-StrictMode -Version 2.0
 
 [Net.ServicePointManager]::SecurityProtocol = [Net.ServicePointManager]::SecurityProtocol -bor 'Tls12'
 
-$versions_path = Join-Path -Path $env:GITHUB_WORKSPACE -ChildPath 'tools' | Join-Path -ChildPath 'versions.json'
+$versions_path = Join-Path -Path $env:GITHUB_WORKSPACE -ChildPath '.ci' | Join-Path -ChildPath 'versions.json'
 $versions = Get-Content $versions_path | ConvertFrom-Json
 Write-Host "[INFO] versions: $versions"
 $erlang_ver = $versions.erlang

.ci/versions.json

@@ -0,0 +1,4 @@
+{
+  "erlang": "25.0.4",
+  "rabbitmq": "3.10.7"
+}

.github/workflows/build-test.yaml

@@ -8,17 +8,17 @@ jobs:
     name: build/test on windows-latest
     runs-on: windows-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-dotnet@v1
+      - uses: actions/checkout@v3
+      - uses: actions/setup-dotnet@v2
         with:
           dotnet-version: 6.0.x
-      - uses: actions/cache@v2
+      - uses: actions/cache@v3
         with:
           # Note: the cache path is relative to the workspace directory
           # https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#using-the-cache-action
           path: ~/installers
-          key: ${{ runner.os }}-v1-${{ hashFiles('tools/versions.json') }}
-      - uses: actions/cache@v2
+          key: ${{ runner.os }}-v1-${{ hashFiles('.ci/versions.json') }}
+      - uses: actions/cache@v3
         with:
           path: |
             ~/.nuget/packages
@@ -27,7 +27,7 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-v2-nuget-
       - name: Install and start RabbitMQ
-        run: ./tools/install.ps1
+        run: ./.ci/install.ps1
       - name: Restore
         run: dotnet restore --verbosity=normal
       - name: Build
@@ -51,11 +51,11 @@ jobs:
             - 1883:1883
             - 61613:61613
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-dotnet@v1
+      - uses: actions/checkout@v3
+      - uses: actions/setup-dotnet@v2
         with:
           dotnet-version: 6.0.x
-      - uses: actions/cache@v2
+      - uses: actions/cache@v3
         with:
           path: |
             ~/.nuget/packages

.github/workflows/publish-nuget.yaml

@@ -10,11 +10,11 @@ jobs:
   publish-nuget:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-dotnet@v1
+      - uses: actions/checkout@v3
+      - uses: actions/setup-dotnet@v2
         with:
           dotnet-version: 6.0.x
-      - uses: actions/cache@v2
+      - uses: actions/cache@v3
         with:
           path: |
             ~/.nuget/packages

.github/workflows/publish.yaml

@@ -1,14 +1,10 @@
 name: publish rabbitmq-stream-dotnet-client
 
 on:
-  create:
-    branches-ignore:
-      - '*'
-    tags:
-      - '*'
-  push:
-    tags:
-      - '*'
+  release:
+    types:
+      # https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#release
+      - published
 
 jobs:
   call-build-test:

README.md

@@ -616,10 +616,10 @@ The client is work in progress. The API(s) could change prior to version `1.0.0`
 * Ensure builds are green: [link](https://github.com/rabbitmq/rabbitmq-stream-dotnet-client/actions)
 * Tag the `main` branch using your GPG key:
     ```
-    git tag -a -s -u GPG_KEY_ID -m 'rabbitmq-stream-dotnet-client v1.0.0-beta.6' 'v1.0.0-beta.6' && git push && git push --tags
+    git tag -a -s -u GPG_KEY_ID -m 'rabbitmq-stream-dotnet-client v1.0.0' 'v1.0.0' && git push && git push --tags
     ```
 * Ensure the build for the tag passes: [link](https://github.com/rabbitmq/rabbitmq-stream-dotnet-client/actions)
+* Create the new release on GitHub, which triggers a build and publish to NuGet: [link](https://github.com/rabbitmq/rabbitmq-stream-dotnet-client/releases)
 * Check for the new version on NuGet: [link](https://www.nuget.org/packages/RabbitMQ.Stream.Client)
   * Best practice is to download the new package and inspect the contents using [NuGetPackageExplorer](https://github.com/NuGetPackageExplorer/NuGetPackageExplorer)
-* Create the new release on GitHub: [link](https://github.com/rabbitmq/rabbitmq-stream-dotnet-client/releases)
 * Announce the new release on the mailing list: [link](https://groups.google.com/g/rabbitmq-users)