Skip to content

Commit a0227bc

Browse files
committed
adding documentation
1 parent de5f710 commit a0227bc

25 files changed

Lines changed: 6721 additions & 279 deletions

.github/workflows/draft-release.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,13 @@ jobs:
8585
npm run build
8686
cd ../..
8787
88+
- name: Install Python dependencies and generate OpenAPI docs
89+
run: |
90+
cd benchmesh-serial-service
91+
pip install -r requirements.txt
92+
PYTHONPATH=src python -m benchmesh_service.tools.gen_openapi
93+
cd ..
94+
8895
- name: Update version in electron package.json
8996
run: |
9097
cd electron
@@ -119,13 +126,25 @@ jobs:
119126
with:
120127
node-version: '20'
121128

129+
- name: Setup Python
130+
uses: actions/setup-python@v5
131+
with:
132+
python-version: '3.11'
133+
122134
- name: Build frontend
123135
run: |
124136
cd benchmesh-serial-service/frontend
125137
npm ci
126138
npm run build
127139
cd ../..
128140
141+
- name: Install Python dependencies and generate OpenAPI docs
142+
run: |
143+
cd benchmesh-serial-service
144+
pip install -r requirements.txt
145+
PYTHONPATH=src python -m benchmesh_service.tools.gen_openapi
146+
cd ..
147+
129148
- name: Create archive
130149
run: |
131150
mkdir -p dist-web/benchmesh

.github/workflows/release-electron.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,11 @@ jobs:
5252
cd benchmesh-serial-service
5353
python -m pytest -v
5454
55+
- name: Generate OpenAPI documentation
56+
run: |
57+
cd benchmesh-serial-service
58+
PYTHONPATH=src python -m benchmesh_service.tools.gen_openapi
59+
5560
get-version:
5661
runs-on: ubuntu-latest
5762
outputs:
@@ -396,13 +401,25 @@ jobs:
396401
- name: Install Node dependencies
397402
run: npm install
398403

404+
- name: Setup Python
405+
uses: actions/setup-python@v5
406+
with:
407+
python-version: '3.11'
408+
399409
- name: Build frontend
400410
run: |
401411
cd benchmesh-serial-service/frontend
402412
npm ci
403413
npm run build
404414
cd ../..
405415
416+
- name: Install Python dependencies and generate OpenAPI docs
417+
run: |
418+
cd benchmesh-serial-service
419+
pip install -r requirements.txt
420+
PYTHONPATH=src python -m benchmesh_service.tools.gen_openapi
421+
cd ..
422+
406423
- name: Create self-hosted archive
407424
run: |
408425
# Create distribution directory

.github/workflows/sync-wiki.yml

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: Sync Documentation to Wiki
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
paths:
8+
- 'docs/**/*.md'
9+
workflow_dispatch: # Allow manual trigger
10+
11+
jobs:
12+
sync-wiki:
13+
runs-on: ubuntu-latest
14+
15+
steps:
16+
- name: Checkout repository
17+
uses: actions/checkout@v4
18+
with:
19+
fetch-depth: 0
20+
21+
- name: Clone wiki repository
22+
run: |
23+
git clone https://${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.wiki.git wiki
24+
25+
- name: Copy documentation files
26+
run: |
27+
cp docs/Home.md wiki/
28+
cp docs/Getting-Started.md wiki/
29+
cp docs/Configuration.md wiki/
30+
cp docs/Automation.md wiki/
31+
cp docs/API-Reference.md wiki/
32+
33+
- name: Commit and push to wiki
34+
run: |
35+
cd wiki
36+
git config user.name "GitHub Actions Bot"
37+
git config user.email "actions@github.com"
38+
39+
if git diff --quiet && git diff --cached --quiet; then
40+
echo "No changes detected"
41+
exit 0
42+
fi
43+
44+
git add *.md
45+
git commit -m "Update documentation from main repository (${GITHUB_SHA::7})"
46+
git push origin master
47+
env:
48+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

0 commit comments

Comments
 (0)