Add the option "ref", specifying either a commit or a branch (#329)

This fixes #242.

Author: mstorsjo

.github/workflows/download.yml

@@ -87,6 +87,37 @@ jobs:
           commit: ${{ github.sha }}
       - name: Test
         run: cat artifact/sha | grep $GITHUB_SHA
+  download-ref-branch:
+    runs-on: ubuntu-latest
+    needs: wait
+    if: github.ref == 'refs/heads/master'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Download
+        uses: ./
+        with:
+          workflow: upload.yml
+          name: artifact
+          path: artifact
+          ref: master
+      - name: Test
+        run: cat artifact/sha | grep $GITHUB_SHA
+  download-ref-commit:
+    runs-on: ubuntu-latest
+    needs: wait
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Download
+        uses: ./
+        with:
+          workflow: upload.yml
+          name: artifact
+          path: artifact
+          ref: ${{ github.sha }}
+      - name: Test
+        run: cat artifact/sha | grep $GITHUB_SHA
   download-multiple:
     runs-on: ubuntu-latest
     needs: wait

README.md

@@ -6,9 +6,9 @@ Let's suppose you have a workflow with a job in it that at the end uploads an ar
 
 ## Usage
 
-> If `commit` or `pr` or `branch` or `run_id` or `workflow_conclusion` is not specified then the artifact from the most recent successfully completed workflow run will be downloaded.
+> If `commit`, `pr`, `branch`, `ref`, `run_id` or `workflow_conclusion` is not specified then the artifact from the most recent successfully completed workflow run will be downloaded.
 
-**Do not specify `pr`, `commit`, `branch`, `run_id` together or `workflow_conclusion` and `run_id` together. Pick just one of each or none.**
+**Do not specify `pr`, `commit`, `branch`, `ref`, `run_id` together or `workflow_conclusion` and `run_id` together. Pick just one of each or none.**
 
 ```yaml
 - name: Download artifact
@@ -38,6 +38,9 @@ Let's suppose you have a workflow with a job in it that at the end uploads an ar
     commit: ${{github.event.pull_request.head.sha}}
     # Optional, will use the specified branch. Defaults to all branches
     branch: master
+    # Optional, branch/tag/commit ID to reference. This can supersede both
+    # branch and commit above.
+    ref: master
     # Optional, defaults to all types
     event: push
     # Optional, will use specified workflow run

action.yml

@@ -42,6 +42,9 @@ inputs:
   branch:
     description: Branch name
     required: false
+  ref:
+    description: Commit hash or branch name
+    required: false
   event:
     description: Event type
     required: false

main.js

@@ -46,6 +46,7 @@ async function main() {
         let pr = core.getInput("pr")
         let commit = core.getInput("commit")
         let branch = core.getInput("branch")
+        let ref = core.getInput("ref")
         let event = core.getInput("event")
         let runID = core.getInput("run_id")
         let runNumber = core.getInput("run_number")
@@ -74,6 +75,7 @@ async function main() {
                 "pr": pr,
                 "commit": commit,
                 "branch": branch,
+                "ref": ref,
                 "run_id": runID
             }
         ]
@@ -96,6 +98,21 @@ async function main() {
             //branch = pull.data.head.ref
         }
 
+        if (ref) {
+            // Try to determine if the ref is a branch or a commit
+            core.info(`==> Ref: ${ref}`)
+            try {
+                const response = await client.rest.repos.getBranch({
+                    owner: owner,
+                    repo: repo,
+                    branch: ref,
+                })
+                branch = ref
+            } catch (error) {
+                commit = ref
+            }
+        }
+
         if (commit) {
             core.info(`==> Commit: ${commit}`)
         }