Skip to content
actions

GitHub Action

Configure GitHub Pages

v5.0.0 Latest version

Configure GitHub Pages

actions

Configure GitHub Pages

A GitHub Action to enable Pages, extract various metadata about a site, and configure some supported static site generators

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Configure GitHub Pages

uses: actions/[email protected]

Learn more about this action in actions/configure-pages

Choose a version

configure-pages

A GitHub Action to enable Pages and extract various metadata about a site. It can also be used to configure various static site generators we support as starter workflows.

See set-pages-config.js for more details on how we configure static site generators to work "out of the box" with GitHub Pages.

Usage

See action.yml and the Pages starter workflows.

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

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

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

License

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