From 74d0f02a66964d4b3c6ff0cfb616d4ad3b2ea2f0 Mon Sep 17 00:00:00 2001 From: Tshepang Mbambo Date: Fri, 23 Jun 2023 11:25:45 +0200 Subject: [PATCH 1/4] readme: fix/improve note about permissions --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 07a01f7..f10f3d0 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,8 @@ The [`tar` file][tar] must: # File Permissions -When using this action ensure your files have appropriate file permission, we expect at a minimum for the files to have permission for the current user (e.g 0744). +When using this action, ensure that your files have appropriate file permissions. +We expect, at a minimum, for the files to have read permission for the current user (e.g 0744). Failure to do so will result in a `deployment_perms_error` when attempting to deploy your artifacts. ```yaml From bc7aff665b087af240d84793319d41b2f0129d91 Mon Sep 17 00:00:00 2001 From: "James M. Greene" Date: Mon, 10 Jul 2023 11:48:45 -0500 Subject: [PATCH 2/4] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f10f3d0..7a0e551 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,9 @@ The [`tar` file][tar] must: # File Permissions When using this action, ensure that your files have appropriate file permissions. -We expect, at a minimum, for the files to have read permission for the current user (e.g 0744). +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 do so will result in a `deployment_perms_error` when attempting to deploy your artifacts. ```yaml From 8f17ae60415e1b8971863e2624f301dd9d2fde44 Mon Sep 17 00:00:00 2001 From: "James M. Greene" Date: Mon, 10 Jul 2023 11:48:50 -0500 Subject: [PATCH 3/4] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7a0e551..e506c69 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,8 @@ 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 do so will result in a `deployment_perms_error` when attempting to deploy your artifacts. + +Failure to supply adequate permissions will result in a `deployment_perms_error` when attempting to deploy your artifacts to GitHub Pages. ```yaml ... From 07f501f6a0ff8cef2d64e4037d704f79061a4bd5 Mon Sep 17 00:00:00 2001 From: "James M. Greene" Date: Mon, 10 Jul 2023 11:59:59 -0500 Subject: [PATCH 4/4] Update README for `v2` Better topic hierarchy and more copy-paste-friendly `chmod` examples --- README.md | 62 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 33 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index e506c69..af113d2 100644 --- a/README.md +++ b/README.md @@ -2,17 +2,17 @@ A composite Action for packaging and uploading artifact that can be deployed to [GitHub Pages][pages]. -# Scope +## Scope ⚠️ Official support for building Pages with Actions is in public beta at the moment. -# Usage +## Usage See [action.yml](action.yml) -# Artifact validation +## Artifact validation While using this action is optional, we highly recommend it since it takes care of producing (mostly) valid artifacts. @@ -25,8 +25,9 @@ The [`tar` file][tar] must: - be under 10GB in size - not contain any symbolic or hard links +- contain only files and directories that all meet the expected minimum [file permissions](#file-permissions) -# File Permissions +### File permissions When using this action, ensure that your files have appropriate file permissions. At a minimum, GitHub Pages expects: @@ -35,34 +36,37 @@ At a minimum, GitHub Pages expects: Failure to supply adequate permissions will result in a `deployment_perms_error` when attempting to deploy your artifacts to GitHub Pages. +#### Example permissions fix for Linux + ```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 }} - -... +steps: +# ... + - name: Fix permissions + run: | + chmod -c -R +rX "_site/" | while read line; do + echo "::warning title=Invalid file permissions automatically fixed::$line" + done + - name: Upload Pages artifact + uses: actions/upload-pages-artifact@v2 +# ... ``` +#### Example permissions fix for Mac + +```yaml +steps: +# ... + - name: Fix permissions + run: | + chmod -v -R +rX "_site/" | while read line; do + echo "::warning title=Invalid file permissions automatically fixed::$line" + done + - name: Upload Pages artifact + uses: actions/upload-pages-artifact@v2 +# ... +``` -# Release instructions +## Release instructions In order to release a new version of this Action: @@ -74,7 +78,7 @@ In order to release a new version of this Action: ⚠️ Environment approval is required. Check the [Release workflow run list][release-workflow-runs]. -# License +## License The scripts and documentation in this project are released under the [MIT License](LICENSE).