Skip to content

Automatically preview website on PR #121

@dlebauer

Description

@dlebauer
  1. Mirror the .github/workflows/publish-docs.yml workflow added to SIPNET (Consolidate docs deployment workflows sipnet#191) to:

This will:

  • Build docs on push and PR.
  • Publish preview associated with the changes.
  • Deploy when PR is merged.
  1. Remove actions that are no longer needed

  2. [Optional]: make sure it works on forked repositories.

  3. Once the PR is submitted or ready to submit, the following settings need to be changed by a maintainer:

  • change build and deploy from 'deploy from a branch' to 'GitHub actions' (settings --> pages --> build and deploy)
  • Make sure the following are enabled
    • "Read and write permissions" for GITHUB_TOKEN (settings -> actions -> general --> workflow permissions
    • "Allow GitHub Actions to deploy to GitHub Pages” (settings --> actions --> general --> workflow permissions
  • Require status check for the job

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions