Skip to content

Commit fb4bdb4

Browse files
authored
feat: automate docs generation.
1 parent c07aff2 commit fb4bdb4

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

.github/workflows/docs.yaml

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,20 @@ on:
44
push:
55
branches:
66
- development
7+
8+
permissions:
9+
contents: write
10+
pull-requests: write
11+
712
jobs:
813
build-docs:
914
runs-on: ubuntu-latest
1015

1116
steps:
1217
- name: Checkout repo
1318
uses: actions/checkout@v4
19+
with:
20+
persist-credentials: false
1421

1522
- name: Set up Python
1623
uses: actions/setup-python@v4
@@ -22,19 +29,17 @@ jobs:
2229
pip install pydoc-markdown
2330
2431
- name: Run pydoc-markdown
25-
working-directory: .
2632
run: |
2733
pydoc-markdown pydoc-markdown.yml
2834
2935
- name: Create Pull Request if docs changed
3036
uses: peter-evans/create-pull-request@v7
3137
with:
3238
branch: docs/regenerate-api-docs
33-
commit-message: chore(docs): regenerate API docs
34-
title: chore(docs): regenerate API docs
39+
commit-message: "chore(docs): regenerate API docs"
40+
title: "chore(docs): regenerate API docs"
3541
body: |
3642
This PR was automatically generated by the workflow to regenerate the API documentation.
3743
add-paths: |
3844
docs/api-reference/python/**
3945
delete-branch: true
40-

0 commit comments

Comments
 (0)