Add dry-run input (#51)

.github/workflows/test.yml

@@ -31,3 +31,4 @@ jobs:
           # For now, you'll need to manually specify a GitHub token until we
           # solve #2. The x: prefix is a dummy username.
           token: x:${{ secrets.GITHUB_TOKEN }}
+          dry-run: ${{ github.ref != 'main' }}

README.md

@@ -95,6 +95,11 @@ one of your GitHub Actions workflows.
   is `Update wiki ${{ github.sha }}`. You probably don't need to change this,
   since this only applies if you look _really closely_ in your wiki.
 
+- **`dry-run`:** Whether or not to actually attempt to push changes back to the
+  wiki itself. If this is set to `true`, we instead print the remote URL and do
+  not push to the remote wiki. The default is `false`. This is useful for
+  testing.
+
 ## Alternatives
 
 There are quite a few GitHub wiki publishing actions on the [GitHub Actions

action.yml

@@ -30,6 +30,13 @@ inputs:
       applies if you look really closely in your wiki.
     required: true
     default: Update wiki ${{ github.sha }}
+  dry-run:
+    description: >-
+      Whether or not to actually attempt to push changes back to the wiki
+      itself. If this is set to true, we instead print the remote URL and do not
+      push to the remote wiki. The default is false. This is useful for testing.
+    required: true
+    default: false
 runs:
   using: composite
   steps:
@@ -41,3 +48,4 @@ runs:
         INPUT_TOKEN: ${{ inputs.token }}
         INPUT_PATH: ${{ inputs.path }}
         INPUT_COMMIT_MESSAGE: ${{ inputs.commit-message }}
+        INPUT_DRY_RUN: ${{ inputs.dry-run }}

src/index.sh

@@ -24,6 +24,12 @@ git reset origin/master
 
 git add --all
 git commit -m "$INPUT_COMMIT_MESSAGE"
-git push -u origin master
+
+if [[ $INPUT_DRY_RUN == true ]]; then
+  git remote show origin
+  git show
+else
+  git push -u origin master
+fi
 
 rm -rf ./.git