Skip to content

Latest commit

 

History

History
40 lines (23 loc) · 2.33 KB

README.md

File metadata and controls

40 lines (23 loc) · 2.33 KB
Raw

jekyll-v4-build-pages

A simple GitHub Action for producing Jekyll build artifacts compatible with GitHub Pages.

This action is not the official action used for GitHub Pages. This is a fork of the original jekyll-build-pages that I have modified to support Jekyll v4. This action will work mostly the same as the original, with the main difference being it will build a Jekyll site with Jekyll v4.x. To see a list of the dependencies that this action uses, checkout out georgeh2os.com/pages-gem/versions.

While you could use this action directly to build a Jekyll site with GitHub Actions, it would be easier to use jekyll-v4-gh-pages if you are looking to build and deploy a Jekyll site with GitHub Actions.

Scope

This is used along with actions/deploy-pages as part of the official support for building Pages with Actions (currently in public beta for public repositories).

Usage

See action.yml

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. Prepare a pull request to update action.yml to reference the incoming version

  3. 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. ☑️

  4. After publishing the release, the release workflow will automatically run to create/update the corresponding the major version tag such as v1.

    ⚠️ Environment approval is required. Check the Release workflow run list.

License

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