Document outputs (#25)

Author: jhuleatt

.github/workflows/deploy-preview.yml

@@ -25,7 +25,9 @@ jobs:
         run: npm ci
       - name: Check that Prettier was run
         run: npm run format:check
-      - uses: ./
+      - name: Deploy to Firebase Hosting preview channel
+        id: firebase_hosting_preview
+        uses: ./
         with:
           repoToken: "${{ secrets.GITHUB_TOKEN }}"
           firebaseServiceAccount: "${{ secrets.FIREBASE_SERVICE_ACCOUNT }}"
@@ -34,3 +36,8 @@ jobs:
           entryPoint: "./demo"
         env:
           FIREBASE_CLI_PREVIEWS: hostingchannels
+      - name: Check outputs
+        run: |
+          echo urls ${{steps.firebase_hosting_preview.outputs.url}}
+          echo expire_time ${{steps.firebase_hosting_preview.outputs.expire_time}}
+          echo details_url ${{steps.firebase_hosting_preview.outputs.details_url}}

README.md

@@ -111,6 +111,22 @@ from your `next` branch to a `preprod` preview channel).
 The location of your [`firebase.json`](https://firebase.google.com/docs/cli#the_firebasejson_file)
 file relative to the root of your repository. Defaults to `.` (the root of your repo).
 
+## Outputs
+
+Values emitted by this action that can be consumed by other actions later in your workflow
+
+### `urls`
+
+The url(s) deployed to
+
+### `expire_time`
+
+The time the deployed preview urls expire
+
+### `details_url`
+
+A single URL that was deployed to
+
 ---
 
 This GitHub Action is not an officially supported Google product

action.yml

@@ -48,3 +48,10 @@ inputs:
       directory"
     default: "."
     required: false
+outputs:
+  urls:
+    description: The url(s) deployed to
+  expire_time:
+    description: The time the deployed preview urls expire
+  details_url:
+    description: A single URL that was deployed to