Skip to content

Commit

Permalink
Merge pull request #99 from actions/remove-permissions-mention
Browse files Browse the repository at this point in the history
Remove mention of file permissions in README
  • Loading branch information
TooManyBees authored Apr 25, 2024
2 parents 56afc60 + 4ee80ee commit ff11fa5
Showing 1 changed file with 0 additions and 39 deletions.
39 changes: 0 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,45 +27,6 @@ The [`tar` file][tar] must:
- not contain any symbolic or hard links
- contain only files and directories that all meet the expected minimum [file permissions](#file-permissions)

### 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.

#### Example permissions fix for Linux

```yaml
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@v3
# ...
```

#### 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@v3
# ...
```

## Release instructions

In order to release a new version of this Action:
Expand Down

0 comments on commit ff11fa5

Please sign in to comment.