Merge pull request #65 from tshepang/patch-1

readme: fix/improve note about permissions

README.md

@@ -26,6 +26,42 @@ The [`tar` file][tar] must:
 - be under 10GB in size
 - not contain any symbolic or hard links
 
+# File Permissions
+
+When using this action, ensure that your files have appropriate file permissions.
+At a minimum, GitHub Pages expects:
+- files to have read permission for the current user and the "Others" user role (e.g. `0744`, `0644`, `0444`)
+- directories to have read and execute permissions for the current user and the "Others" user role (e.g. `0755`, `0555`)
+
+Failure to supply adequate permissions will result in a `deployment_perms_error` when attempting to deploy your artifacts to GitHub Pages.
+
+```yaml
+...
+runs:
+  using: composite
+  steps:
+    - name: Archive artifact
+      shell: sh
+      if: runner.os == 'Linux'
+      run: |
+        chmod -c -R +rX "$INPUT_PATH" |
+        while read line; do
+           echo "::warning title=Invalid file permissions automatically fixed::$line"
+        done
+        tar \
+          --dereference --hard-dereference \
+          --directory "$INPUT_PATH" \
+          -cvf "$RUNNER_TEMP/artifact.tar" \
+          --exclude=.git \
+          --exclude=.github \
+          .
+      env:
+        INPUT_PATH: ${{ inputs.path }}
+
+...
+```
+
+
 # Release instructions
 
 In order to release a new version of this Action:
@@ -47,6 +83,6 @@ The scripts and documentation in this project are released under the [MIT Licens
 [release-list]: https://github.com/actions/upload-pages-artifact/releases
 [draft-release]: .github/workflows/draft-release.yml
 [release]: .github/workflows/release.yml
-[release-workflow-runs]: /actions/workflows/release.yml
+[release-workflow-runs]: https://github.com/actions/upload-pages-artifact/actions/workflows/release.yml
 [gzip]: https://en.wikipedia.org/wiki/Gzip
 [tar]: https://en.wikipedia.org/wiki/Tar_(computing)