Skip to content

Commit 84bb4cd

Browse files
authored
Merge pull request #65 from tshepang/patch-1
readme: fix/improve note about permissions
2 parents 81e1caf + 8f17ae6 commit 84bb4cd

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,12 @@ The [`tar` file][tar] must:
2828

2929
# File Permissions
3030

31-
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).
32-
Failure to do so will result in a `deployment_perms_error` when attempting to deploy your artifacts.
31+
When using this action, ensure that your files have appropriate file permissions.
32+
At a minimum, GitHub Pages expects:
33+
- files to have read permission for the current user and the "Others" user role (e.g. `0744`, `0644`, `0444`)
34+
- directories to have read and execute permissions for the current user and the "Others" user role (e.g. `0755`, `0555`)
35+
36+
Failure to supply adequate permissions will result in a `deployment_perms_error` when attempting to deploy your artifacts to GitHub Pages.
3337

3438
```yaml
3539
...

0 commit comments

Comments
 (0)