Upload-Pages-Artifact

A composite action for packaging and uploading artifact that can be deployed to GitHub Pages.

Scope

⚠️ Official support for building Pages with Actions is in public beta at the moment.

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 single tar 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:

1. Locate the semantic version of the upcoming release (a draft is maintained by the draft-release workflow)

2. Push a matching tag, for instance for v0.1.0:

   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)

   ⚠️ Environment approval is required.

License

The scripts and documentation in this project are released under the MIT License.