Skip to content

Ensure GitHub Pages is enabled and configured on the repository #106

Description

Context

Repositories using Process-PSModule generate documentation that is published to GitHub Pages. The repository settings need to have GitHub Pages enabled and configured for GitHub Actions deployment for this to work.

Request

The workflow should ensure that GitHub Pages is enabled on the repository and configured for GitHub Actions deployment. Additionally, the repository description URL should be set to the GitHub Pages URL.

Acceptance criteria

  • The workflow verifies or configures GitHub Pages on the repository
  • Pages is set to deploy via GitHub Actions (not branch-based)
  • The repository description URL is updated to the Pages URL
  • If Pages is already configured correctly, no changes are made

Technical decisions

To be determined during implementation planning — uses the GitHub Pages API.


Implementation plan

  • Check if GitHub Pages is enabled on the repository
  • If not enabled, enable Pages with GitHub Actions as the source
  • Update the repository homepage/description URL to the Pages URL
  • Skip configuration if already correct
  • Test with repositories that have and do not have Pages configured

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions