Merge pull request #3 from humbletim/humbletim-patch-1

add support for sdk-x.y.z branch names

Author: humbletim

.github/workflows/ci.yml

@@ -44,6 +44,19 @@ jobs:
           echo "VULKAN_SDK=='$VULKAN_SDK'"
           test -n "$VULKAN_SDK_VERSION"
 
+  setup-ubuntu-with-sdk-version:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ./
+        with:
+          vulkan-version: sdk-1.1.101
+      - name: Test Vulkan SDK Install
+        run: |
+          echo "Vulkan SDK Version=='$VULKAN_SDK_VERSION'"
+          echo "VULKAN_SDK=='$VULKAN_SDK'"
+          test -n "$VULKAN_SDK_VERSION"
+
   setup-windows-without-version:
     runs-on: windows-latest
     steps:

README.md

@@ -1,4 +1,4 @@
-# setup-vulkan-sdk v1.0.1
+# setup-vulkan-sdk v1.0.2
 
 <p align="left">
   <a href="https://github.com/humbletim/setup-vulkan-sdk"><img alt="GitHub Actions status" src="https://github.com/humbletim/setup-vulkan-sdk/workflows/Setup/badge.svg"></a>
@@ -13,26 +13,35 @@ This action builds a subset of the Vulkan SDK from source and makes the results
 To build against the latest Vulkan SDK:
 ```yaml
   -name: Install Vulkan SDK
-   uses: humbletim/[email protected].1
+   uses: humbletim/[email protected].2
 ```
 
 ## Parameters
 
 - `vulkan-version`:
-*(Optional)* valid SDK release number (eg: 1.2.161.1). Default: `latest`
+*(Optional)* valid SDK release number (eg: 1.2.161.1) or git branch (eg: sdk-1.2.161). Default: `latest`
     - Available release numbers can be found here: https://vulkan.lunarg.com/sdk/home
+    - Note: sdk-x.y.z branches are used directly whereas release numbers get resolved through Vulkan SDK webservices
 
-## Specifying an exact SDK version:
+## Specifying an exact SDK by *packaged release number*:
 ```yaml
   -name: Install Vulkan SDK
-   uses: humbletim/[email protected].1
+   uses: humbletim/[email protected].2
    with:
      vulkan-version: 1.2.161.1
 ```
 
+## Specifying an exact SDK by *khronos git branch*:
+```yaml
+  -name: Install Vulkan SDK
+   uses: humbletim/[email protected]
+   with:
+     vulkan-version: sdk-1.1.108
+```
+
 ## How it works
 
-First [action.yml](action.yml) installs the minimum dependencies needed to compile Vulkan SDK from source. It then delegates to [install_vulkan_sdk.sh](install_vulkan_sdk.sh), which resolves `vulkan-version` into a corresponding git branch using the official Vulkan SDK [web services](https://vulkan.lunarg.com/content/view/latest-sdk-version-api). 
+First [action.yml](action.yml) installs the minimum dependencies needed to compile Vulkan SDK from source. It then delegates to [install_vulkan_sdk.sh](install_vulkan_sdk.sh), which if needed resolves `vulkan-version` into a corresponding git branch using the official Vulkan SDK [web services](https://vulkan.lunarg.com/content/view/latest-sdk-version-api).
 
 [KhronosGroup/Vulkan-Headers](https://github.com/KhronosGroup/Vulkan-Headers) and [KhronosGroup/Vulkan-Loader](https://github.com/KhronosGroup/Vulkan-Loader) repos are then cloned locally to that branch point, built, and installed into `$PWD/VULKAN_SDK`. And finally a `VULKAN_SDK` environment variable is exported for later build tools to discover the SDK's location through.
 

action.yml

@@ -5,15 +5,15 @@ branding:
   color: 'red'  
 inputs:
   vulkan-version:
-    description: 'specify a Vulkan SDK release version, e.g. 1.2.162.1'
+    description: 'specify a Vulkan SDK release version, e.g. 1.2.162.1 (or git branch like sdk-1.2.162)'
     default: 'latest'
     required: false
   vulkan-version-linux:
-    description: 'specify a linux-specific Vulkan SDK release version, e.g. 1.2.162.1'
+    description: 'specify a linux-specific Vulkan SDK release version, e.g. 1.2.162.1 (or git branch like sdk-1.2.162)'
     default: ''
     required: false
   vulkan-version-windows:
-    description: 'specify a windows-specific Vulkan SDK release version, e.g. 1.2.162.1'
+    description: 'specify a windows-specific Vulkan SDK release version, e.g. 1.2.162.1 (or git branch like sdk-1.2.162)'
     default: ''
     required: false
 runs:

install_vulkan_sdk.sh

@@ -3,8 +3,9 @@
 # currently outputs into VULKAN_SDK in the current directory
 # 2021.02 humbletim -- released under the MIT license
 
-# usage: ./install_vulkan_sdk.sh <SDK_release_version>
-#    eg: ./install_vulkan_sdk.sh 1.2.162.1
+# usage: ./install_vulkan_sdk.sh <SDK_release_version | sdk-x.y.z>
+#    eg: ./install_vulkan_sdk.sh 1.2.162.1 # branch resolved via service
+#    eg: ./install_vulkan_sdk.sh sdk-1.2.162 # branch used directly
 
 # log messages will be printed to STDERR (>&2)
 # these sourcable environment variables will be printed to STDOUT on success:
@@ -34,18 +35,45 @@ case `uname -s` in
 esac
 echo os=$os >&2
 
-# convert an official SDK Release Number into an actual git commit tag (eg: 1.2.162.1 => sdk-1.2.162)
-BRANCH=$(curl https://vulkan.lunarg.com/sdk/config/$VK_VERSION/$os/config.json | jq '.repos["Vulkan-Headers"].branch' --raw-output)
+# resolve latest into an actual SDK release number (currently only used for troubleshooting / debug output)
+REAL_VK_VERSION=$VK_VERSION
+if [[ $VK_VERSION == latest ]] ; then
+  REAL_VK_VERSION=$(curl -s https://vulkan.lunarg.com/sdk/latest.json | jq .$os --raw-output)
+  echo "resolved $VK_VERSION=$REAL_VK_VERSION" >&2
+fi
+
+if [[ $VK_VERSION == sdk-*.*.* ]] ; then
+  echo "using specified branch/tag name as-is: $VK_VERSION" >&2
+  BRANCH=$VK_VERSION
+else
+  # convert an official SDK Release Number into an actual git commit tag (eg: 1.2.162.1 => sdk-1.2.162)
+  BRANCH=$(curl -s https://vulkan.lunarg.com/sdk/config/$VK_VERSION/$os/config.json | jq '.repos["Vulkan-Headers"].branch' --raw-output)
+fi
+
 echo BRANCH=$BRANCH >&2
 
-mkdir VULKAN_SDK/_build
+if [[ $BRANCH == null ]] ; then
+  echo "error: could not resolve $VK_VERSION ($REAL_VK_VERSION) into a git branch via Vulkan SDK service" >&2
+  echo "raw CURL output (https://vulkan.lunarg.com/sdk/config/$VK_VERSION/$os/config.json)" >&2
+  echo "-------------------------------------------------------" >&2
+  curl -i https://vulkan.lunarg.com/sdk/config/$VK_VERSION/$os/config.json >&2
+  echo -e "\n-------------------------------------------------------" >&2
+  echo "NOTE -- according to the web service, these versions are available for os=$os:" >&2
+  curl -s https://vulkan.lunarg.com/sdk/versions/$os.json | jq --raw-output '.[]' >&2
+  echo -e "\n... aborting" >&2
+  exit 1
+fi
+
+test -d VULKAN_SDK/_build || mkdir VULKAN_SDK/_build
 pushd VULKAN_SDK/_build >&2
+
   git clone https://github.com/KhronosGroup/Vulkan-Headers.git --branch $BRANCH >&2
   pushd Vulkan-Headers >&2
     cmake -DCMAKE_INSTALL_PREFIX=../.. -DCMAKE_BUILD_TYPE=Release . >&2
     cmake --build . --config Release >&2
     cmake --install . >&2
   popd >&2
+
   git clone https://github.com/KhronosGroup/Vulkan-Loader.git --branch $BRANCH >&2
   pushd Vulkan-Loader >&2
     cmake -DVULKAN_HEADERS_INSTALL_DIR=../.. -DCMAKE_INSTALL_PREFIX=../.. -DCMAKE_BUILD_TYPE=Release . >&2
@@ -54,6 +82,8 @@ pushd VULKAN_SDK/_build >&2
   popd >&2
 popd >&2
 
+echo "" >&2
+
 # export these so that "sourcing" this file directly also works
 export VULKAN_SDK_VERSION=$BRANCH
 export VULKAN_SDK=$PWD/VULKAN_SDK
@@ -65,6 +95,6 @@ echo VULKAN_SDK=$VULKAN_SDK
 # cleanup _build artifacts which are no longer needed after cmake --installs above
 rm -rf VULKAN_SDK/_build >&2
 
-echo "VULKAN_SDK/" >&2
-ls VULKAN_SDK >&2
+# echo "VULKAN_SDK/" >&2
+# ls VULKAN_SDK >&2
 du -hs VULKAN_SDK >&2