include version in archive tarball filenames?

Author: zkat

.github/workflows/release.yml

@@ -31,28 +31,31 @@ jobs:
 
       - name: Build docs
         uses: mattnotmitt/doxygen-action@v1.9.5
-
+        
+      - name: Set env
+        run: echo "ARCHIVE_FILENAME_PREFIX=fastly-compute-sdk-cpp-${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
+        
       - name: Archive core dist
-        run: tar cvf fastly-compute-sdk-cpp.tar -C target/release/dist fastly libfastly.a
+        run: tar cvf ${{ env.ARCHIVE_FILENAME_PREFIX }}.tar -C target/release/dist fastly libfastly.a
 
       - name: Archive quickstart dist
-        run: tar cvf fastly-compute-sdk-cpp-quickstart.tar -C target/release/dist fastly libfastly.a
+        run: tar cvf ${{ env.ARCHIVE_FILENAME_PREFIX }}-quickstart.tar -C target/release/dist fastly libfastly.a
 
       - name: Add docs and license to quickstart dist
-        run: tar rvf fastly-compute-sdk-cpp-quickstart.tar docs LICENSE
+        run: tar rvf ${{ env.ARCHIVE_FILENAME_PREFIX }}-quickstart.tar docs LICENSE
 
       - name: Add quickstart files to quickstart dist
-        run: tar rvf fastly-compute-sdk-cpp-quickstart.tar -C quickstart CMakeLists.txt fastly.toml main.cpp README.md
+        run: tar rvf ${{ env.ARCHIVE_FILENAME_PREFIX }}-quickstart.tar -C quickstart CMakeLists.txt fastly.toml main.cpp README.md
 
       - name: Gzip core dist
-        run: gzip fastly-compute-sdk-cpp.tar
+        run: gzip ${{ env.ARCHIVE_FILENAME_PREFIX }}.tar
 
       - name: Gzip quickstart dist
-        run: gzip fastly-compute-sdk-cpp-quickstart.tar
+        run: gzip ${{ env.ARCHIVE_FILENAME_PREFIX }}-quickstart.tar
 
       - uses: ncipollo/release-action@v1
         with:
-          artifacts: fastly-compute-sdk-cpp*.tar.gz
+          artifacts: "${{ env.ARCHIVE_FILENAME_PREFIX }}*.tar.gz"
           artifactErrorsFailBuild: true
           artifactContentType: "application/gzip"
           generateReleaseNotes: true

README.md

@@ -3,7 +3,7 @@
 This SDK is lets you use Fastly Compute platform directly with C++, using a
 C++-native API with all the usual facilities of modern C++. In case you got to
 this page from elsewhere, the full documentation is available online at [this
-link](https://cuddly-adventure-lrw9z3m.pages.github.io/index.html).
+link](https://cuddly-adventure-lrw9z3m.pages.github.io).
 
 #### Examples
 
@@ -20,7 +20,7 @@ To use the SDK from the prebuilt static library, all you need is:
 #### Quickstart
 
 The fastest way to get started with the SDK is to fetch
-`fastly-compute-sdk-cpp-quickstart.tar.gz` from the [latest GitHub Release's
+`fastly-compute-sdk-cpp-quickstart-vX.Y.Z.tar.gz` from the [latest GitHub Release's
 assets list](https://github.com/fastly/compute-sdk-cpp/releases/latest). This
 tarball includes a full prebuilt version of the library, its headers, a copy of
 the full reference docs, and a set of quickstart files with a preconfigured,
@@ -29,7 +29,7 @@ CMake-based project.
 #### Just the SDK
 
 If you only need the latest version of the library, fetch
-`fastly-compute-sdk-cpp-quickstart.tar.gz` from the [latest GitHub Release's
+`fastly-compute-sdk-cpp-vX.Y.Z-quickstart.tar.gz` from the [latest GitHub Release's
 assets list](https://github.com/fastly/compute-sdk-cpp/releases/latest) and
 place it somewhere accessible to your preferred build system.
 

quickstart/README.md

@@ -48,7 +48,10 @@ curl -d "hello, world!" http://127.0.0.1:7676/
 
 ## Documentation
 
-The release tarball includes the HTML reference docs in `docs/html/index.html`,
-which you can open locally. If you've configured your editor properly, you may
-also be able to hover over Fastly SDK symbols to see their documentation
-in-place.
+Online documentation can be accessed
+[here](https://cuddly-adventure-lrw9z3m.pages.github.io/).
+
+The quickstart tarball also includes the HTML reference docs in
+`docs/index.html`, which you can open locally. If you've configured your editor
+properly, you may also be able to hover over Fastly SDK symbols to see their
+documentation in-place.