2022-08-10 14:03:15 -05:00
|
|
|
# upload-pages-artifact
|
2022-05-24 14:46:39 -07:00
|
|
|
|
|
|
|
|
A composite action for packaging and uploading artifact that can be deployed to [GitHub Pages][pages].
|
|
|
|
|
|
|
|
|
|
# Scope
|
|
|
|
|
|
2022-07-13 11:47:37 -07:00
|
|
|
⚠️ Official support for building Pages with Actions is in public beta at the moment.
|
2022-05-24 14:46:39 -07:00
|
|
|
|
|
|
|
|
# Usage
|
|
|
|
|
|
|
|
|
|
See [action.yml](action.yml)
|
|
|
|
|
|
|
|
|
|
<!-- TODO: document custom workflow -->
|
|
|
|
|
|
2022-07-13 11:47:37 -07:00
|
|
|
# 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][gzip] containing a single [`tar` file][tar]
|
|
|
|
|
|
|
|
|
|
The [`tar` file][tar] must:
|
|
|
|
|
|
|
|
|
|
- be under 10GB in size
|
|
|
|
|
- not contain any symbolic or hard links
|
|
|
|
|
|
2022-05-24 15:20:30 -07:00
|
|
|
# Release instructions
|
|
|
|
|
|
|
|
|
|
In order to release a new version of this Action:
|
|
|
|
|
|
|
|
|
|
1. Locate the semantic version of the upcoming release (a draft is maintained by the [`draft-release` workflow][draft-release])
|
|
|
|
|
|
|
|
|
|
2. Push a matching tag, for instance for `v0.1.0`:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
git tag v0.1.0
|
|
|
|
|
git push origin v0.1.0
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
3. Publish the draft release (the major tag such as `v0` will be created/updated by the [`release` workflow][release])
|
|
|
|
|
|
|
|
|
|
⚠️ Environment approval is required.
|
|
|
|
|
|
2022-05-24 14:46:39 -07:00
|
|
|
# License
|
|
|
|
|
|
|
|
|
|
The scripts and documentation in this project are released under the [MIT License](LICENSE).
|
|
|
|
|
|
|
|
|
|
<!-- references -->
|
|
|
|
|
[pages]: https://pages.github.com
|
2022-05-24 15:20:30 -07:00
|
|
|
[draft-release]: .github/workflows/draft-release.yml
|
2022-07-13 11:47:37 -07:00
|
|
|
[release]: .github/workflows/release.yml
|
|
|
|
|
[gzip]: https://en.wikipedia.org/wiki/Gzip
|
2022-08-10 14:03:15 -05:00
|
|
|
[tar]: https://en.wikipedia.org/wiki/Tar_(computing)
|
