Skip to content

Commit

Permalink
Merge pull request #65 from tshepang/patch-1
Browse files Browse the repository at this point in the history
readme: fix/improve note about permissions
  • Loading branch information
JamesMGreene authored Jul 10, 2023
2 parents 81e1caf + 8f17ae6 commit 84bb4cd
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,12 @@ 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).
Failure to do so will result in a `deployment_perms_error` when attempting to deploy your artifacts.
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
...
Expand Down

0 comments on commit 84bb4cd

Please sign in to comment.