upload-pages-artifact
A composite Action for packaging and uploading artifact that can be deployed to GitHub Pages.
Scope
Usage
See action.yml
Artifact validation
While using this action is optional, we highly recommend it since it takes care of producing (mostly) valid artifacts.
A Pages artifact must:
- Be called
github-pages
- Be a single
gzip
archive containing a singletar
file
The tar
file must:
- be under 10GB in size
- not contain any symbolic or hard links
Release instructions
In order to release a new version of this Action:
-
Locate the semantic version of the upcoming release (a draft is maintained by the
draft-release
workflow). -
Publish the draft release from the
main
branch with semantic version as the tag name, with the checkbox to publish to the GitHub Marketplace checked.☑️ -
After publishing the release, the
release
workflow will automatically run to create/update the corresponding the major version tag such asv0
.⚠️ Environment approval is required. Check the Release workflow run list.
License
The scripts and documentation in this project are released under the MIT License.