Skip to content

Latest commit

 

History

History
37 lines (22 loc) · 1.41 KB

README.md

File metadata and controls

37 lines (22 loc) · 1.41 KB

publish-github-pages

Publishes a directory as the GitHub Pages website for the current repository.

Example

steps:
  - uses: giancosta86/aurora-github/actions/publish-github-pages@v4

Requirements

  • The following permissions must be set for the action to work:

    • pages: write

    • id-token: write

    Please, note: at the same time, you may want to declare your required default permissions - such as contents, necessary for some Git operations - because, otherwise, they would be disabled by an explicit permissions block.

  • GitHub Pages must be enabled for the current repository - and having GitHub Actions as their source.

  • It is recommended that GitHub Actions have read/write permissions on the repository.

Inputs 📥

Name Type Description Default value
source-directory string Relative directory containing the website website
shell string The shell used to run commands bash

Further references