add url output, add test, add readme example (#11)

Author: bollwyvl

.github/workflows/main.yml

@@ -3,6 +3,8 @@ jobs:
   circleci_artifacts_redirector_job:
     runs-on: ubuntu-latest
     name: Run CircleCI artifacts redirector
+    outputs:
+      url: ${{ steps.run-circleci-artifacts-redirector.outputs.url }}
     steps:
       # WARNING!
       # This repo uses the action in its own root directory.
@@ -16,3 +18,14 @@ jobs:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
           artifact-path: 0/test_artifacts/root_artifact.md
         id: run-circleci-artifacts-redirector
+
+  use_outputs_job:
+    runs-on: ubuntu-latest
+    needs: [circleci_artifacts_redirector_job]
+    name: Use the output
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@master
+      - name: Check the URL
+        run: |
+          curl --fail ${{ needs.circleci_artifacts_redirector_job.outputs.url }} | grep $GITHUB_SHA

README.md

@@ -14,11 +14,16 @@ jobs:
     name: Run CircleCI artifacts redirector
     steps:
       - name: GitHub Action step
+        id: step1
         uses: larsoner/circleci-artifacts-redirector-action@master
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
           artifact-path: 0/test_artifacts/root_artifact.md
           circleci-jobs: build_doc
+      - name: Check the URL
+        run: |
+          curl --fail ${{ steps.step1.outputs.url }} | grep $GITHUB_SHA
+
 ```
 
 - The `artifact-path` should point to an artifact path from your CircleCI

action.yml

@@ -14,6 +14,9 @@ inputs:
   circleci-jobs:
     description: 'Comma-separated list of CircleCI jobs to monitor (default is "build_docs,build,doc")'
     required: false
+outputs:
+  url:
+    description: 'The full redirect URL'
 on: status
 runs:
   using: 'node12'