Skip to content

Commit

Permalink
Github Pages deployment action for docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sceboucher committed Sep 22, 2024
1 parent 4310c9d commit df16036
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Deploy Docs to GitHub Pages

on:
push:
branches:
- main # Set this to your default branch
pull_request:
branches:
- main # Set this to your default branch

jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v3

- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs
publish_branch: gh-pages # The branch the action should deploy to
user_name: 'github-actions[bot]'
user_email: 'github-actions[bot]@users.noreply.github.com'
commit_message: 'Deploy docs to GitHub Pages'

0 comments on commit df16036

Please sign in to comment.