Skip to content

Commit fd1a22f

Browse files
committed
removed token, added actions + diable var
1 parent c888192 commit fd1a22f

File tree

1 file changed

+19
-23
lines changed

1 file changed

+19
-23
lines changed

.github/workflows/update-plugin-docs.yml

Lines changed: 19 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -12,38 +12,34 @@ on:
1212

1313
jobs:
1414
generate_docs:
15+
runs-on: ubuntu-latest
16+
# To disable this workflow, set DISABLE_AUTO_DOCS to 'true' in repository variables
17+
if: vars.DISABLE_AUTO_DOCS != 'true'
1518

16-
runs-on: 'Docker-in-Docker'
17-
container: python:3.10
18-
env:
19-
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
20-
BRANCH_NAME: ${{ github.ref_name }}
2119
steps:
22-
- name: Code checkout
23-
run: |
24-
rm -rf node-scraper
25-
git clone -b ${BRANCH_NAME} https://${GITHUB_PAT}@github.com/amd/node-scraper.git node-scraper
20+
- name: Checkout repository
21+
uses: actions/checkout@v4
22+
with:
23+
token: ${{ secrets.GITHUB_TOKEN }}
24+
25+
- name: Set up Python
26+
uses: actions/setup-python@v5
27+
with:
28+
python-version: '3.9'
2629

2730
- name: Install dependencies
28-
run: |
29-
cd node-scraper
30-
./dev-setup.sh
31+
run: ./dev-setup.sh
3132

3233
- name: Run plugin documentation generator
3334
run: |
34-
cd node-scraper/docs
35-
python generate_plugin_doc_bundle.py --package nodescraper.plugins.inband --output PLUGIN_DOC.md
35+
python docs/generate_plugin_doc_bundle.py \
36+
--package nodescraper.plugins.inband \
37+
--output docs/PLUGIN_DOC.md
3638
37-
- name: Commit documentation changes
39+
- name: Commit and push changes
3840
run: |
3941
git config --global user.name "github-actions[bot]"
40-
git config --global user.email "<>"
41-
cd node-scraper
42+
git config --global user.email "github-actions[bot]@users.noreply.github.com"
4243
git add docs/PLUGIN_DOC.md
43-
git commit -m "Updated plugin documentation" || echo "No changes to plugin documentation"
44+
git diff --staged --quiet || git commit -m "docs: Update plugin documentation [automated]"
4445
git push
45-
46-
- name: Clean up
47-
if: always()
48-
run: |
49-
rm -rf node-scraper

0 commit comments

Comments
 (0)