mirror of
https://github.com/eunomia-bpf/bpf-developer-tutorial.git
synced 2026-10-28 19:24:04 +08:00
docs: add generated tutorial compatibility matrix (#212)
* docs: declare tutorial compatibility requirements * docs: generate tutorial compatibility matrix * fix: correct BPF Arena minimum kernel * refactor: simplify compatibility validation --------- Co-authored-by: LinuxDev9002 <i@littlefisher.me>
This commit is contained in:
4
.github/workflows/auto-generate-docs.yml
vendored
4
.github/workflows/auto-generate-docs.yml
vendored
@@ -8,6 +8,7 @@ on:
|
||||
- 'src/**/README.zh.md'
|
||||
- 'src/**/.config'
|
||||
- 'scripts/generate_toc.py'
|
||||
- 'scripts/generate_compatibility.py'
|
||||
- 'scripts/*.template'
|
||||
workflow_dispatch:
|
||||
|
||||
@@ -33,6 +34,7 @@ jobs:
|
||||
- name: Generate documentation
|
||||
run: |
|
||||
python3 scripts/generate_toc.py
|
||||
python3 scripts/generate_compatibility.py
|
||||
|
||||
- name: Check for changes
|
||||
id: check_changes
|
||||
@@ -44,6 +46,6 @@ jobs:
|
||||
run: |
|
||||
git config --local user.email "github-actions[bot]@users.noreply.github.com"
|
||||
git config --local user.name "github-actions[bot]"
|
||||
git add README.md README.zh.md src/SUMMARY.md src/SUMMARY.zh.md
|
||||
git add README.md README.zh.md src/SUMMARY.md src/SUMMARY.zh.md src/compatibility.md src/compatibility.zh.md
|
||||
git commit -m "docs: auto-generate documentation"
|
||||
git push
|
||||
|
||||
8
.github/workflows/check-docs.yml
vendored
8
.github/workflows/check-docs.yml
vendored
@@ -14,10 +14,12 @@ jobs:
|
||||
steps:
|
||||
- uses: actions/checkout@v7
|
||||
- name: Test documentation scripts
|
||||
run: python3 -m unittest scripts.test_check_internal_links scripts.test_generate_toc
|
||||
run: python3 -m unittest scripts.test_check_internal_links scripts.test_generate_toc scripts.test_generate_compatibility
|
||||
- name: Regenerate documentation indexes
|
||||
run: python3 scripts/generate_toc.py
|
||||
run: |
|
||||
python3 scripts/generate_toc.py
|
||||
python3 scripts/generate_compatibility.py
|
||||
- name: Verify generated documentation is current
|
||||
run: git diff --exit-code -- README.md README.zh.md src/SUMMARY.md src/SUMMARY.zh.md
|
||||
run: git diff --exit-code -- README.md README.zh.md src/SUMMARY.md src/SUMMARY.zh.md src/compatibility.md src/compatibility.zh.md
|
||||
- name: Check relative Markdown links
|
||||
run: python3 scripts/check_internal_links.py
|
||||
|
||||
Reference in New Issue
Block a user