actions/upload-pages-artifact
1
0
Fork 0
mirror of https://github.com/actions/upload-pages-artifact.git synced 2026-02-09 03:45:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'main' into JamesMGreene-patch-1

Browse Source
This commit is contained in:
James M. Greene
2024-05-01 21:25:02 -05:00
committed by GitHub
parent 39a95dabfa bb87865510
commit 36a9e8110d
6 changed files with 23 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
README.md
View File

@@ -2,10 +2,6 @@
A composite Action for packaging and uploading artifact that can be deployed to [GitHub Pages][pages].
## Scope
⚠️ Official support for building Pages with Actions is in public beta at the moment.
## Usage
See [action.yml](action.yml)
@@ -27,46 +23,7 @@ The [`tar` file][tar] must:
- :warning: The GitHub Pages [officially supported maximum size limit is 1GB][pages-usage-limits], so the subsequent deployment of larger tarballs are not guaranteed to succeed — often because they are more prone to exceeding the maximum deployment timeout of 10 minutes.
- ⛔ However, there is also an _unofficial_ absolute maximum size limit of 10GB, which Pages will not even _attempt_ to deploy.
- 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@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
# ...
```
- contain only files and directories
## Release instructions