|
1 | 1 | name: Kernel Requirements CI |
2 | 2 | on: |
3 | 3 | push: |
| 4 | + |
4 | 5 | jobs: |
| 6 | + discover-llr: |
| 7 | + name: Find LLR candidates with coccinelle |
| 8 | + runs-on: ubuntu-24.04 |
| 9 | + steps: |
| 10 | + - uses: actions/checkout@v3 |
| 11 | + |
| 12 | + - name: install coccinelle |
| 13 | + run: sudo apt install coccinelle |
| 14 | + |
| 15 | + - name: Run coccinelle |
| 16 | + run: scripts/coccinelle/docs/find_doc_elements.sh | tee ${{ runner.temp }}/llr_candidates.txt >(wc -l | xargs printf "Found %s elements.\n") |
| 17 | + |
| 18 | + - uses: actions/upload-artifact@v4 |
| 19 | + with: |
| 20 | + name: LLR candidates found with Coccinelle |
| 21 | + path: ${{ runner.temp }}/llr_candidates.txt |
| 22 | + overwrite: true |
| 23 | + |
5 | 24 | build: |
6 | 25 | permissions: |
7 | 26 | contents: write |
8 | | - name: Search for functions that need documentation |
| 27 | + name: Validate and render requirements |
9 | 28 | runs-on: ubuntu-24.04 |
10 | 29 | steps: |
11 | | - - uses: actions/checkout@v3 |
| 30 | + - uses: actions/checkout@v4 |
| 31 | + |
| 32 | + - name: install kbuild dependencies |
| 33 | + run: sudo apt install bison flex |
12 | 34 |
|
13 | 35 | - name: install StrictDoc |
14 | | - run: sudo apt install coccinelle |
| 36 | + run: pipx install strictdoc |
15 | 37 |
|
16 | | - - name: Run coccinelle |
17 | | - run: cocci/find_doc_elements.sh | tee >(wc -l | xargs printf "We need to document %s elements.\n") |
| 38 | + - run: make defconfig |
| 39 | + |
| 40 | + - name: strictdoc export |
| 41 | + run: strictdoc export --output $RUNNER_TEMP/export . |
| 42 | + |
| 43 | + - uses: actions/checkout@v4 |
| 44 | + with: |
| 45 | + ref: lpc25_add_trace_events_enabled |
| 46 | + fetch-depth: 3 |
| 47 | + |
| 48 | + - name: strictdoc generate diff view |
| 49 | + run: strictdoc export . --output ${{ runner.temp }}/diff --generate-diff-git="HEAD^^..HEAD" |
| 50 | + |
| 51 | + - run: mv ${{ runner.temp }}/diff/html $RUNNER_TEMP/export/html/diff_view |
| 52 | + |
| 53 | + - name: Upload static files as artifact |
| 54 | + id: deployment |
| 55 | + uses: actions/upload-pages-artifact@v3 |
| 56 | + with: |
| 57 | + path: ${{ runner.temp }}/export/html |
| 58 | + |
| 59 | + deploy: |
| 60 | + needs: build |
| 61 | + |
| 62 | + permissions: |
| 63 | + pages: write |
| 64 | + id-token: write |
| 65 | + |
| 66 | + environment: |
| 67 | + name: github-pages |
| 68 | + url: ${{ steps.deployment.outputs.page_url }} |
| 69 | + |
| 70 | + runs-on: ubuntu-latest |
| 71 | + steps: |
| 72 | + - name: Deploy to GitHub Pages |
| 73 | + id: deployment |
| 74 | + uses: actions/deploy-pages@v4 |
0 commit comments