Skip to content

Commit 93de4d9

Browse files
schneaLea Evers
andauthored
fix: fetch plugin documentation (#26)
fixes #23 . Since GH became more agressive with its rate limiting, the collection of plugin docs would fail with a HTTP status code 429: Too many requests. This PR moves the markdown fetching logic from plain http requests to using gitPython. ## Test Plan 1. run `pixi run build` 2. Open the `build/index.html` file and check that a. Plugins that provide 'intro.md' (e.g. the slurm executor plugin) have their documentation displayed b. Pages that do not provide their own documentation show a little warning box <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Refactor** * Switched plugin documentation retrieval to a Git-based cloning approach with multi-branch support, replacing the prior HTTP-based retrieval. * **Chores** * Added a Git-related dependency (gitpython) to support repository cloning. * **Style** * Cleaned up CI workflow YAML formatting and alignment; no behavioral changes. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Lea Evers <l.evers@yandex.com>
1 parent 44b7911 commit 93de4d9

4 files changed

Lines changed: 193 additions & 75 deletions

File tree

.github/workflows/deploy.yml

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@ name: Deploy
22

33
on:
44
push:
5-
branches: [ main ]
5+
branches: [main]
66
workflow_dispatch:
77
schedule:
88
# * is a special character in YAML so you have to quote this string
9-
- cron: '50 4 * * *'
9+
- cron: "50 4 * * *"
1010

1111
defaults:
1212
run:
@@ -16,31 +16,31 @@ jobs:
1616
deploy:
1717
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
1818
permissions:
19-
pages: write # to deploy to Pages
20-
id-token: write # to verify the deployment originates from an appropriate source
19+
pages: write # to deploy to Pages
20+
id-token: write # to verify the deployment originates from an appropriate source
2121
environment:
2222
name: github-pages
2323
url: ${{ steps.deployment.outputs.page_url }}
2424

2525
# Specify runner + deployment step
2626
runs-on: ubuntu-latest
2727
steps:
28-
- uses: actions/checkout@v4
28+
- uses: actions/checkout@v4
2929

30-
- uses: prefix-dev/setup-pixi@v0.9.0
31-
with:
32-
cache: true
30+
- uses: prefix-dev/setup-pixi@v0.9.0
31+
with:
32+
cache: true
3333

34-
- name: Building
35-
run: pixi run build
34+
- name: Building
35+
run: pixi run build
3636

37-
- name: Setup Pages
38-
uses: actions/configure-pages@v5
39-
- name: Upload artifact
40-
uses: actions/upload-pages-artifact@v3
41-
with:
42-
path: "build"
37+
- name: Setup Pages
38+
uses: actions/configure-pages@v5
39+
- name: Upload artifact
40+
uses: actions/upload-pages-artifact@v3
41+
with:
42+
path: "build"
4343

44-
- name: Deploy artifact
45-
id: deployment
46-
uses: actions/deploy-pages@v4
44+
- name: Deploy artifact
45+
id: deployment
46+
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)