ardupilot/.github/workflows/test_scripting.yml at master · HumpbackLab/ardupilot · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
name: test scripting

on:
  push:
    branches: ['**']  # excludes tag pushes
    paths: # only run for scripting changes
      - 'libraries/AP_Scripting/tests/docs_check.py'
      - 'libraries/AP_Scripting/generator/**'
      - '**.lua'
      - 'Tools/scripts/run_lua_language_check.py'
      - 'Tools/scripts/run_luacheck.sh'
      - 'Tools/scripts/generate_lua_docs.sh'
      - '.github/workflows/test_scripting.yml'
      - '.github/problem-matchers/Lua.json'

  pull_request:
    paths: # only run for scripting changes
      - 'libraries/AP_Scripting/tests/docs_check.py'
      - 'libraries/AP_Scripting/generator/**'
      - '**.lua'
      - 'Tools/scripts/run_lua_language_check.py'
      - 'Tools/scripts/run_luacheck.sh'
      - 'Tools/scripts/generate_lua_docs.sh'
      - '.github/workflows/test_scripting.yml'
      - '.github/problem-matchers/Lua.json'

  workflow_dispatch:

concurrency:
  group: ci-${{github.workflow}}-${{ github.ref }}
  cancel-in-progress: true

permissions:
  contents: read

jobs:
  test-scripting:
    runs-on: ubuntu-slim
    steps:
      # git checkout the PR
      - uses: actions/checkout@v7
        with:
          submodules: false
          persist-credentials: false

      - name: Checkout waf submodule
        run: git submodule update --init --recursive --depth 1 modules/waf

      - name: Install pip dependencies
        run: |
          python3 -m pip install github-release-downloader empy==3.3.4

      - name: Register lua check problem matcher
        run: |
          echo "::add-matcher::.github/problem-matchers/Lua.json"
          echo "::remove-matcher owner=Lua-language-server-problem-matcher::"

      - name: Lua Linter
        shell: bash
        run: |
          sudo apt-get update
          sudo apt-get -y install lua-check
          ./Tools/scripts/run_luacheck.sh

      - name: Register lua language server problem matcher
        run: |
          echo "::add-matcher::.github/problem-matchers/Lua.json"
          echo "::remove-matcher owner=Luacheck-problem-matcher::"

      - name: Language server check
        shell: bash
        run: |
          python3 ./Tools/scripts/run_lua_language_check.py --debugLogging

      - name: Remove problem matchers
        run: |
          echo "::remove-matcher owner=Luacheck-problem-matcher::"
          echo "::remove-matcher owner=Lua-language-server-problem-matcher::"

      - name: Generate lua markdown API docs
        shell: bash
        run: |
          ./Tools/scripts/generate_lua_docs.sh

      - name: Copy current lua docs
        run: |
          PATH="/github/home/.local/bin:$PATH"
          mv "libraries/AP_Scripting/docs/docs.lua" "libraries/AP_Scripting/docs/current_docs.lua"

      - name: ReGenerate lua docs and annotations from code
        shell: bash
        run: |
          ./waf configure
          ./waf scripting_docs

      - name: Compare Previous and current lua docs
        run: |
          PATH="/github/home/.local/bin:$PATH"
          python ./libraries/AP_Scripting/tests/docs_check.py "./libraries/AP_Scripting/docs/docs.lua" "./libraries/AP_Scripting/docs/current_docs.lua"

      - name: Upload docs
        uses: actions/upload-artifact@v7
        with:
          name: Docs
          path: ScriptingDocs.md
          retention-days: 7