Skip to content

Commit 55df86d

Browse files
committed
feat: add github workflows
1 parent 9dd182c commit 55df86d

File tree

3 files changed

+90
-0
lines changed

3 files changed

+90
-0
lines changed

.github/dependabot.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# To get started with Dependabot version updates, you'll need to specify which
2+
# package ecosystems to update and where the package manifests are located.
3+
# Please see the documentation for all configuration options:
4+
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
5+
6+
version: 2
7+
updates:
8+
- package-ecosystem: github-actions
9+
directory: /
10+
schedule:
11+
interval: "weekly"
12+
groups:
13+
actions:
14+
patterns:
15+
- "*"

.github/workflows/deploy.yml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Deploy Documentation
2+
on:
3+
push:
4+
branches:
5+
- main # Set the branch you want to trigger the deployment
6+
7+
jobs:
8+
deploy:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- name: Checkout Repository
12+
uses: actions/checkout@v5
13+
14+
- name: Set up Python
15+
uses: actions/setup-python@v4
16+
with:
17+
python-version: '3.x'
18+
19+
- name: Install Dependencies
20+
run: |
21+
python -m pip install --upgrade pip
22+
pip install nox
23+
nox -s docs
24+
25+
- name: Deploy to GitHub Pages
26+
uses: peaceiris/actions-gh-pages@v4
27+
with:
28+
github_token: ${{ secrets.GITHUB_TOKEN }}
29+
publish_dir: ./site
30+
user_name: 'github-actions[bot]'
31+
user_email: 'github-actions[bot]@users.noreply.github.com'
32+
commit_message: 'Deploy documentation'

.github/workflows/preview.yml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Preview Documentation
2+
on:
3+
pull_request:
4+
branches:
5+
- main # Set the branch you want to trigger the preview
6+
7+
jobs:
8+
preview:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- name: Checkout Repository
12+
uses: actions/checkout@v5
13+
14+
- name: Set up Python
15+
uses: actions/setup-python@v4
16+
with:
17+
python-version: '3.x'
18+
19+
- name: Install Dependencies
20+
run: |
21+
python -m pip install --upgrade pip
22+
pip install nox
23+
nox -s docs
24+
25+
- name: Deploy to gh-pages (destination dir pr-<number>)
26+
uses: peaceiris/actions-gh-pages@v4
27+
with:
28+
github_token: ${{ secrets.GITHUB_TOKEN }}
29+
publish_dir: ./site
30+
# create a unique directory per PR so pages can co-exist
31+
destination_dir: pr-${{ github.event.number }}
32+
# commit message
33+
commit_message: "Deploy docs preview for PR #${{ github.event.number }} (sha: ${{ github.sha }})"
34+
35+
- name: Create or update PR comment with preview URL
36+
uses: peter-evans/create-or-update-comment@v3
37+
with:
38+
token: ${{ secrets.GITHUB_TOKEN }}
39+
issue-number: ${{ github.event.number }}
40+
body: |
41+
🔎 **Docs preview for this PR**
42+
Preview URL: `https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/pr-${{ github.event.number }}/`
43+
(Automatically updated by workflow)

0 commit comments

Comments
 (0)