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

Deploy directly to Github Pages through Github Actions #5

Open
rollerozxa opened this issue Jan 22, 2025 · 0 comments
Open

Deploy directly to Github Pages through Github Actions #5

rollerozxa opened this issue Jan 22, 2025 · 0 comments

Comments

@rollerozxa
Copy link
Member

Currently it deploys to Github Pages through pushing commits to the gh-pages branch. This isn't necessary anymore since you can directly deploy a directory to Github Pages from Github Actions, reducing the amount of repository size churn that will happen when it commits automatically generated content into the repository.

The pages: write permission will need to be added to the top of the YAML, and then to deploy directly to Github pages the following steps would do that:

      - name: Setup Pages
        if: ${{ env.DID_PUSH == 'true' }}
        uses: actions/configure-pages@v4

      - name: Upload artifact
        if: ${{ env.DID_PUSH == 'true' }}
        uses: actions/upload-pages-artifact@v3
        with:
          path: 'principia/doc/doxy/html/'

      - name: Deploy to GitHub Pages
        if: ${{ env.DID_PUSH == 'true' }}
        id: deployment
        uses: actions/deploy-pages@v4

Repository settings will also need to be changed to match.

Image

@rollerozxa rollerozxa mentioned this issue Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant