https://github.com/actions/configure-pages

An 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.
https://github.com/actions/configure-pages

Last synced: 12 months ago
JSON representation

An 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.

• Host: GitHub
• URL: https://github.com/actions/configure-pages
• Owner: actions
• License: mit
• Created: 2022-07-13T20:18:34.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-12-09T11:18:10.000Z (over 1 year ago)
• Last Synced: 2025-05-09T20:07:28.397Z (about 1 year ago)
• Language: JavaScript
• Homepage: https://pages.github.com
• Size: 6.78 MB
• Stars: 173
• Watchers: 6
• Forks: 60
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# 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][starter-workflows].

See [`set-pages-config.js`](src/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](action.yml) and the [Pages starter workflows][starter-workflows].

# Release instructions

In order to release a new version of this Action:

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

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. :ballot_box_with_check:

3. After publishing the release, the [`release` workflow][release] 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][release-workflow-runs].

# License

The scripts and documentation in this project are released under the [MIT License](LICENSE).

[starter-workflows]: https://github.com/actions/starter-workflows/tree/main/pages

[release-list]: https://github.com/actions/configure-pages/releases

[draft-release]: .github/workflows/draft-release.yml

[release]: .github/workflows/release.yml

[release-workflow-runs]: https://github.com/actions/configure-pages/actions/workflows/release.yml