mirror of
https://github.com/actions/upload-pages-artifact.git
synced 2026-02-09 03:45:23 +00:00
Remove mention of file permissions in README
This commit is contained in:
39
README.md
39
README.md
@@ -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:
|
||||
|
||||
Reference in New Issue
Block a user