Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor automatic docs deployment #1053

Open
woodruffw opened this issue May 10, 2023 · 0 comments
Open

Refactor automatic docs deployment #1053

woodruffw opened this issue May 10, 2023 · 0 comments
Labels
good first issue Good for newcomers hacktoberfest help wanted Extra attention is needed

Comments

@woodruffw
Copy link
Member

The current docs-deploy.yml should be rewritten to use GitHub's first-party support for publishing in GitHub Actions, like so:

name: Documentation

on:
  push:
    branches:
      - main

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3

      # DOCS STEP HERE

      - name: upload docs artifact
        uses: actions/upload-pages-artifact@v1
        with:
          path: ./html/

  deploy:
    needs: build
    runs-on: ubuntu-latest
    permissions:
      # NOTE: Needed to push to the repository.
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - id: deployment
        uses: actions/deploy-pages@v2
@woodruffw woodruffw added help wanted Extra attention is needed good first issue Good for newcomers hacktoberfest labels May 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers hacktoberfest help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant