Skip to content

Commit

Permalink
[CHORE] Deploy documentation to GitHub Pages with GitHub Actions (#11)
Browse files Browse the repository at this point in the history
Deploy documentation to GitHub Pages with GitHub Actions
  • Loading branch information
mathroule authored Jun 11, 2024
1 parent bd4661c commit 30c1c42
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions .github/workflows/deploy-documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Deploy documentation

on:
push:
branches:
- master
paths:
- 'docs/**'

permissions:
contents: read
pages: write
id-token: write

jobs:
deploy-documentation:
name: Deploy documentation to GitHub Pages
environment:
name: github-pages
url: ${{ steps.deploy-documentation.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Configure GitHub Pages
uses: actions/configure-pages@v5

- name: Archive documentation
run: tar --directory docs -cvf docs.tar .

- name: Upload documentation
uses: actions/upload-artifact@v4
with:
name: github-pages
path: docs.tar
retention-days: 1

- name: Deploy documentation
id: deploy-documentation
uses: actions/deploy-pages@v4

0 comments on commit 30c1c42

Please sign in to comment.