aleks/flix
1
0
Fork 0
mirror of https://github.com/okalachev/flix.git synced 2026-09-25 20:02:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improvements in the docs building

Browse Source 
Build the book after downloading additional files, so additional md files can be passed through the builder.
Add more tests for docs artifact.
Publish current git commit on the docs.
Minor simplifications.
This commit is contained in:
Oleg Kalachev
2026-09-21 05:39:20 +03:00
parent 756a400ce5
commit 2ce0a730a4
1 changed files with 10 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/workflows/docs.yml
+10 -6
View File
@@ -33,8 +33,6 @@ jobs:
- uses: actions/checkout@v7 - uses: actions/checkout@v7
- name: Install mdBook - name: Install mdBook
run: cargo install mdbook --vers 0.4.43 --locked run: cargo install mdbook --vers 0.4.43 --locked
- name: Build book
run: cd docs && mdbook build
- name: Download additional files - name: Download additional files
if: ${{ env.QUADCOPTER_DEV_TOKEN && env.FULL }} if: ${{ env.QUADCOPTER_DEV_TOKEN && env.FULL }}
uses: actions/checkout@v7 uses: actions/checkout@v7
@@ -46,7 +44,9 @@ jobs:
fetch-depth: 1 fetch-depth: 1
- name: Add additional files - name: Add additional files
if: ${{ env.QUADCOPTER_DEV_TOKEN && env.FULL }} if: ${{ env.QUADCOPTER_DEV_TOKEN && env.FULL }}
run: cp -a quadcopter.dev/. docs/build/ run: rsync -a --keep-dirlinks quadcopter.dev/. docs/book/
- name: Build book
run: cd docs && mdbook build
- name: Wait for Build to complete - name: Wait for Build to complete
if: ${{ env.FULL }} if: ${{ env.FULL }}
uses: matiasalbarello/wait-on-check-action-ts@v1.2.0 uses: matiasalbarello/wait-on-check-action-ts@v1.2.0
@@ -59,7 +59,7 @@ jobs:
if: ${{ env.FULL }} if: ${{ env.FULL }}
id: build_run id: build_run
run: | run: |
RUN_ID=$(gh api "repos/${{ github.repository }}/actions/workflows/build.yml/runs?head_sha=${{ github.sha }}&per_page=1" --jq '.workflow_runs[0].id') RUN_ID=$(gh api "repos/${{ github.repository }}/actions/workflows/build.yml/runs?head_sha=${{ github.sha }}" --jq '.workflow_runs[0].id')
echo "id=$RUN_ID" >> $GITHUB_OUTPUT echo "id=$RUN_ID" >> $GITHUB_OUTPUT
env: env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -83,11 +83,15 @@ jobs:
ln -s "$FQBN/flix.ino.bin" "flix.$BOARD.bin" ln -s "$FQBN/flix.ino.bin" "flix.$BOARD.bin"
ln -s "$FQBN/flix.ino.bootloader.bin" "flix.$BOARD.bootloader.bin" ln -s "$FQBN/flix.ino.bootloader.bin" "flix.$BOARD.bootloader.bin"
done done
- name: Put version file
run: echo "${{ github.sha }}" > docs/build/version.txt
- name: Test build artifacts - name: Test build artifacts
working-directory: docs/build working-directory: docs/build
run: | run: |
ls; ls index.html gyro.html geometry.html firmware.html flix.esp32.merged.bin flix.esp32c3.merged.bin \ tree -a -I .git
flix.esp32s3.merged.bin flix.esp32s3.opi.merged.bin flix.esp32s3.qspi.merged.bin flix.flix2.merged.bin ls index.html gyro.html geometry.html firmware.html flix.esp32.merged.bin flix.esp32c3.merged.bin \
flix.esp32s3.merged.bin flix.esp32s3.opi.merged.bin flix.esp32s3.qspi.merged.bin flix.flix2.merged.bin \
meta/general.json meta/parameters.json version.txt
- name: Upload artifact - name: Upload artifact
uses: actions/upload-pages-artifact@v5 uses: actions/upload-pages-artifact@v5
with: with: