1616# specific language governing permissions and limitations
1717# under the License.
1818
19- name : Generated Docs Check
19+ name : Generated Docs
2020
2121concurrency :
2222 group : ${{ github.repository }}-${{ github.head_ref || github.sha }}-${{ github.workflow }}
4747 # https://docs.github.com/en/actions/managing-workflow-runs/manually-running-a-workflow
4848 workflow_dispatch :
4949
50-
51- generated-docs-check :
52- name : check configs.md and ***_functions.md is up-to-date
53- needs : linux-build-lib
54- runs-on : ubuntu-latest
55- container :
56- image : amd64/rust
57- steps :
58- - uses : actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
59- with :
60- submodules : true
61- fetch-depth : 1
62- - name : Setup Rust toolchain
63- uses : ./.github/actions/setup-builder
64- with :
65- rust-version : stable
66- - uses : actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
67- with :
68- node-version : " 20"
69- - name : Check if configs.md has been modified
70- run : |
71- # If you encounter an error, run './dev/update_config_docs.sh' and commit
72- ./dev/update_config_docs.sh
73- git diff --exit-code
74- - name : Check if any of the ***_functions.md has been modified
75- run : |
76- # If you encounter an error, run './dev/update_function_docs.sh' and commit
77- ./dev/update_function_docs.sh
78- git diff --exit-code
50+ jobs :
51+ generated-docs-check :
52+ name : check configs.md and ***_functions.md is up-to-date
53+ needs : linux-build-lib
54+ runs-on : ubuntu-latest
55+ container :
56+ image : amd64/rust
57+ steps :
58+ - uses : actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
59+ with :
60+ submodules : true
61+ fetch-depth : 1
62+ - name : Setup Rust toolchain
63+ uses : ./.github/actions/setup-builder
64+ with :
65+ rust-version : stable
66+ - uses : actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
67+ with :
68+ node-version : " 20"
69+ - name : Check if configs.md has been modified
70+ run : |
71+ # If you encounter an error, run './dev/update_config_docs.sh' and commit
72+ ./dev/update_config_docs.sh
73+ git diff --exit-code
74+ - name : Check if any of the ***_functions.md has been modified
75+ run : |
76+ # If you encounter an error, run './dev/update_function_docs.sh' and commit
77+ ./dev/update_function_docs.sh
78+ git diff --exit-code
0 commit comments