Merge pull request #129 from rossjrw/enable-qr

Enable QR codes by default

Author: rossjrw

.github/workflows/preview-example.yml

@@ -20,4 +20,3 @@ jobs:
               uses: ./
               with:
                   source-dir: test/fixtures/sample
-                  qr-code: true

README.md

@@ -7,7 +7,7 @@ Features:
 -   Creates and deploys previews of pull requests to your GitHub Pages site
 -   Leaves a comment on the pull request with a link to the preview so that you and your team can collaborate on new features faster
 -   Updates the deployment and the comment whenever new commits are pushed to the pull request
--   Can optionally include a QR code in the preview comment for easy mobile access
+-   Includes a QR code in the preview comment for easy mobile access
 -   Cleans up after itself — removes deployed previews when the pull request is closed
 -   Can be configured to override any of these behaviours
 
@@ -105,7 +105,7 @@ The following input parameters are provided, which can be passed to the `with` p
 | `pages-base-path` | Path that GitHub Pages is being served from, as configured in your repository settings, e.g. `docs/`. When generating the preview URL path, this is removed from the beginning of the file path. <br><br> Default: `.` (repository root) |
 | `wait-for-pages-deployment` <br> (boolean) | Whether to wait for the GitHub Pages deployment to complete. When enabled, the action will poll the GitHub Deployments API and delay workflow completion until the Pages deployment finishes, e.g. to ensure the preview URL is accessible when the comment is posted. <br><br> Default: `false` (this will be `true` in a future version of this Action) |
 | `comment` <br> (boolean) | Whether to leave a [sticky comment](https://github.com/marocchino/sticky-pull-request-comment) on the PR after the preview is built.<br> The comment may be added before the preview finishes deploying unless `wait-for-pages-deployment` is enabled. <br><br> Default: `true` |
-| `qr-code` <br> (booleanish) | Whether to include a QR code in the sticky comment for easy mobile access, which links to the preview URL. Does nothing if `comment` is `false`. <br> Set to `"true"`/`"false"` to enable/disable, or to a string to be used as a custom QR code provider ([see below](#use-a-different-qr-code-provider)). <br><br> Default: `false` |
+| `qr-code` <br> | Whether to include a QR code in the sticky comment for easy mobile access, which links to the preview URL. Only affects the default comment (i.e. if `comment` is not `false`). <br> Enabled by default - set to `false` to disable, or to a string to use a different provider ([see below](#use-a-different-qr-code-provider)). <br><br> Default: [`https://qr.rossjrw.com/?color.dark=0d1117&url=`](https://qr.rossjrw.com) |
 | `token` | Authentication token for the preview deployment. <br> The default value works for non-fork pull requests to the same repository. For anything else, you will need a [Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) with permission to access it, and [store it as a secret](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions) in your repository. E.g. you might name that secret 'PREVIEW_TOKEN' and use it with `token: ${{ secrets.PREVIEW_TOKEN }}`. <br><br> Default: `${{ github.token }}`, which gives the action permission to deploy to the current repository. |
 | `action` <br> (enum) | Determines what this action will do when it is executed. Supported values: <br><br> <ul><li>`deploy` - create and deploy the preview, overwriting any existing preview in that location.</li><li>`remove` - remove the preview.</li><li>`auto` - determine whether to deploy or remove the preview based on [the emitted event](https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull_request). If the event is `pull_request`, it will deploy the preview when the event type is `opened`, `reopened` and `synchronize`, and remove it on `closed` events. Does not do anything for other events or event types, even if you explicitly instruct the workflow to run on them.</li><li>`none` and all other values: does not do anything.</li></ul> Default: `auto` |
 
@@ -346,18 +346,6 @@ Set `wait-for-deployment: true` to make the action automatically wait for Pages
       wait-for-pages-deployment: true
 ```
 
-### Use a different QR code provider
-
-If you have this action include a QR code in the sticky comment with `qr-code: true`, the default QR code provider is [qr.rossjrw.com](https://qr.rossjrw.com/), a provider that I built for this project because I don't trust any pre-existing ones. Likewise, you probably shouldn't trust mine - what if I go rogue and change all your QR codes to point to something else? You never know.
-
-To use a different QR code provider (I encourage you to make your own - consider forking https://github.com/rossjrw/qrcode-worker), set `qr-code` to its URL. The URI-encoded preview link will be appended to it. E.g.:
-
-```yml
-- uses: rossjrw/pr-preview-action@v1
-  with:
-      qr-code: https://my-qrcode-provider.example.com/generate?url=
-```
-
 ### Customise the sticky comment
 
 You can use `id`, `with: comment: false`, the output values and [context variables](https://docs.github.com/en/actions/reference/workflows-and-actions/contexts) to construct your own comment to be left on the PR. This example recreates this Action's default comment (complete with HTML spacing jank), but you could change it however you like, use a different commenting Action from the marketplace, etc.
@@ -396,7 +384,7 @@ jobs:
                   message: |
                       [PR Preview Action](https://github.com/rossjrw/pr-preview-action) ${{ steps.preview-step.outputs.action-version }}
                       :---:
-                      | <p><img src="https://qr.rossjrw.com/?url=${preview_url}" height="100" align="right" alt="QR code for preview link"></p> :rocket: View preview at <br> ${{ steps.preview-step.outputs.preview-url }} <br><br>
+                      | <p><img src="https://qr.rossjrw.com/?url=${{ steps.preview-step.outputs.preview-url }}" height="100" align="right" alt="QR code for preview link"></p> :rocket: View preview at <br> ${{ steps.preview-step.outputs.preview-url }} <br><br>
                       | <h6>Built to branch [`${{ env.PREVIEW_BRANCH }}`](${{ github.server_url }}/${{ github.repository }}/tree/${{ env.PREVIEW_BRANCH }}) at ${{ steps.preview-step.outputs.action-start-time }}. <br> Preview will be ready when the [GitHub Pages deployment](${{ github.server_url }}/${{ github.repository }}/deployments) is complete. <br><br> </h6>
 
             - uses: marocchino/sticky-pull-request-comment@v2
@@ -410,6 +398,20 @@ jobs:
                       ${{ steps.preview-step.outputs.action-start-time }}
 ```
 
+### Use a different QR code provider
+
+If you have this action include a QR code in the sticky comment with `qr-code: true`, the default QR code provider is [qr.rossjrw.com](https://qr.rossjrw.com/), a provider that I built for this project because I don't trust any pre-existing ones. Likewise, you probably shouldn't trust mine - what if I go rogue and change all your QR codes to point to something else? You never know.
+
+To use a different QR code provider (it's easy to make your own - consider forking https://github.com/rossjrw/qrcode-worker), set `qr-code` to its URL. The URI-encoded preview link will be appended to it. E.g.:
+
+```yml
+- uses: rossjrw/pr-preview-action@v1
+  with:
+      qr-code: https://my-qrcode-provider.example.com/generate?url=
+```
+
+If using a customised comment with `comment: false`, simply construct the image URL from your chosen provider's URL and the preview URL (`${{ steps.[JOB ID].outputs.preview-url }}`).
+
 # Acknowledgements
 
 Big thanks to the following:

action.yml

@@ -64,9 +64,9 @@ inputs:
         required: false
         default: "true"
     qr-code:
-        description: Whether to display a QR code in the sticky comment.
+        description: URL to a QR code provider to generate a QR code for the preview URL in the comment. Preview URL will be appended to the string. Or, set to "false" to disable QR code generation.
         required: false
-        default: "false"
+        default: "https://qr.rossjrw.com/?color.dark=0d1117&url="
     deploy-commit-message:
         description: The commit message to use when adding/updating a preview.
         required: false
@@ -147,7 +147,6 @@ runs:
               deployment_repository: ${{ inputs.deploy-repository }}
               token: ${{ inputs.token }}
               deprecated_custom_url: ${{ inputs.custom-url }}
-              qr_code_wanted: ${{ inputs.qr-code }}
           run: $GITHUB_ACTION_PATH/lib/main.sh
           shell: bash
 
@@ -203,7 +202,7 @@ runs:
                 "${{ inputs.deploy-repository }}" \
                 "${{ env.action_start_time }}" \
                 "deploy" \
-                "${{ env.qr_code_provider }}")
+                "${{ inputs.qr-code }}")
               {
                 echo "content<<EOF"
                 echo "$CONTENT"

lib/generate-comment.sh

@@ -13,6 +13,16 @@ action_start_time=${7:?missing action_start_time}
 deployment_action=${8:?missing deployment_action}
 qr_code_provider=${9:-} # falsy qr code provider means no QR code
 
+if [ "$qr_code_provider" = "true" ]; then
+    # Default to builtin provider
+    qr_code_provider="https://qr.rossjrw.com/?color.dark=0d1117&url="
+fi
+if [ "$qr_code_provider" = "false" ]; then
+    qr_code_provider=""
+else
+    echo >&2 "Using QR code provider: $qr_code_provider<URL>"
+fi
+
 if [ "$deployment_action" = "deploy" ]; then
     qr_code=""
     if [ -n "$qr_code_provider" ]; then

lib/main.sh

@@ -5,7 +5,7 @@ source "$GITHUB_ACTION_PATH/lib/calculate-pages-base-url.sh"
 source "$GITHUB_ACTION_PATH/lib/remove-prefix-path.sh"
 source "$GITHUB_ACTION_PATH/lib/determine-auto-action.sh"
 
-declare deployment_action pr_number deployment_repository pages_base_url pages_base_path umbrella_path action_repository action_ref deprecated_custom_url qr_code_wanted
+declare deployment_action pr_number deployment_repository pages_base_url pages_base_path umbrella_path action_repository action_ref deprecated_custom_url
 
 # Deprecation of custom-url in favour of pages-base-url
 if [ -z "$pages_base_url" ] && [ -n "$deprecated_custom_url" ]; then
@@ -35,17 +35,6 @@ action_version=$("$GITHUB_ACTION_PATH/lib/find-current-git-tag.sh" -p "$action_r
 action_start_timestamp=$(date '+%s')
 action_start_time=$(date '+%Y-%m-%d %H:%M %Z')
 
-if [ "$qr_code_wanted" != "false" ]; then
-    if [ "$qr_code_wanted" = "true" ]; then
-        qr_code_provider="https://qr.rossjrw.com/?color.dark=0d1117&url="
-    else
-        qr_code_provider="$qr_code_wanted"
-    fi
-    echo >&2 "Using QR code provider: $qr_code_provider<URL>"
-else
-    qr_code_provider=""
-fi
-
 # Export variables for later use by this action
 {
     echo "empty_dir_path=$(mktemp -d)"
@@ -59,8 +48,6 @@ fi
     echo "action_repository=$action_repository"
     echo "action_version=$action_version"
     echo "action_start_time=$action_start_time"
-
-    echo "qr_code_provider=$qr_code_provider"
 } >> "$GITHUB_ENV"
 
 # Export variables for use by later actions in user workflow

test/unit/test-comment-content.sh

@@ -36,7 +36,7 @@ assert_file_contains "$comment_file" "$action_version"
 assert_file_contains "$comment_file" "$preview_url"
 assert_file_contains "$comment_file" "Built to branch"
 assert_file_contains "$comment_file" "pr-12345"
-assert_file_contains "$comment_file" "qr.rossjrw.com" && exit 1 || true
+assert_file_contains "$comment_file" "/?url=" && exit 1 || true
 
 echo >&2 "test comment: removal"
 echo >&2 "==============================="
@@ -57,11 +57,11 @@ echo >&2 "==============================="
 assert_file_contains "$comment_file" "PR Preview Action"
 assert_file_contains "$comment_file" "$action_version"
 assert_file_contains "$comment_file" "Preview removed"
-assert_file_contains "$comment_file" "qr.rossjrw.com" && exit 1 || true
+assert_file_contains "$comment_file" "/?url=" && exit 1 || true
 
 echo >&2 "test comment: deployment with QR code"
 echo >&2 "==============================="
-qr_code_provider="https://qr.rossjrw.com/?url="
+qr_code_provider="https://qr.example.com/?url="
 bash lib/generate-comment.sh \
     "$action_repository" \
     "$action_version" \
@@ -77,4 +77,24 @@ qr_code_provider=""
 cat >&2 "$comment_file"
 echo >&2 "==============================="
 
-assert_file_contains "$comment_file" "qr.rossjrw.com/?url=$preview_url"
+assert_file_contains "$comment_file" "qr.example.com/?url=$preview_url"
+
+echo >&2 "test comment: deployment with QR code, backwards compatibility with qr-code:true"
+echo >&2 "==============================="
+qr_code_provider="true"
+bash lib/generate-comment.sh \
+    "$action_repository" \
+    "$action_version" \
+    "$preview_url" \
+    "$preview_branch" \
+    "$server_url" \
+    "$deployment_repository" \
+    "$action_start_time" \
+    "deploy" \
+    "$qr_code_provider" \
+    > "$comment_file"
+qr_code_provider=""
+cat >&2 "$comment_file"
+echo >&2 "==============================="
+
+assert_file_contains "$comment_file" "qr.rossjrw.com"