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

Update README for v2

Browse Source 
Better topic hierarchy and more copy-paste-friendly `chmod` examples
This commit is contained in:
James M. Greene
2023-07-10 11:59:59 -05:00
committed by GitHub
parent 84bb4cd4b7
commit 07f501f6a0
1 changed files with 33 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
README.md
View File

@@ -2,17 +2,17 @@
A composite Action for packaging and uploading artifact that can be deployed to [GitHub Pages][pages]. A composite Action for packaging and uploading artifact that can be deployed to [GitHub Pages][pages].
# Scope ## Scope
⚠️ Official support for building Pages with Actions is in public beta at the moment. ⚠️ Official support for building Pages with Actions is in public beta at the moment.
# Usage ## Usage
See [action.yml](action.yml) See [action.yml](action.yml)
<!-- TODO: document custom workflow --> <!-- TODO: document custom workflow -->
# Artifact validation ## Artifact validation
While using this action is optional, we highly recommend it since it takes care of producing (mostly) valid artifacts. While using this action is optional, we highly recommend it since it takes care of producing (mostly) valid artifacts.
@@ -25,8 +25,9 @@ The [`tar` file][tar] must:
- be under 10GB in size - be under 10GB in size
- not contain any symbolic or hard links - not contain any symbolic or hard links
- contain only files and directories that all meet the expected minimum [file permissions](#file-permissions)
# File Permissions ### File permissions
When using this action, ensure that your files have appropriate file permissions. When using this action, ensure that your files have appropriate file permissions.
At a minimum, GitHub Pages expects: At a minimum, GitHub Pages expects:
@@ -35,34 +36,37 @@ At a minimum, GitHub Pages expects:
Failure to supply adequate permissions will result in a `deployment_perms_error` when attempting to deploy your artifacts to GitHub Pages. Failure to supply adequate permissions will result in a `deployment_perms_error` when attempting to deploy your artifacts to GitHub Pages.
```yaml #### Example permissions fix for Linux
...
runs:
using: composite
steps:
- name: Archive artifact
shell: sh
if: runner.os == 'Linux'
run: |
chmod -c -R +rX "$INPUT_PATH" |
while read line; do
echo "::warning title=Invalid file permissions automatically fixed::$line"
done
tar \
--dereference --hard-dereference \
--directory "$INPUT_PATH" \
-cvf "$RUNNER_TEMP/artifact.tar" \
--exclude=.git \
--exclude=.github \
.
env:
INPUT_PATH: ${{ inputs.path }}
... ```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
# Release instructions ```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
# ...
```
## Release instructions
In order to release a new version of this Action: In order to release a new version of this Action:
@@ -74,7 +78,7 @@ In order to release a new version of this Action:
⚠️ Environment approval is required. Check the [Release workflow run list][release-workflow-runs]. ⚠️ Environment approval is required. Check the [Release workflow run list][release-workflow-runs].
# License ## License
The scripts and documentation in this project are released under the [MIT License](LICENSE). The scripts and documentation in this project are released under the [MIT License](LICENSE).