Check workflows for issues during CI #17
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Basic checks | |
| permissions: | |
| contents: read | |
| on: [workflow_call, workflow_dispatch] | |
| jobs: | |
| workflowcheck: | |
| name: Check validity of GitHub workflows | |
| runs-on: ubuntu-latest | |
| container: openquantumsafe/ci-ubuntu-latest:latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4@692973e3d937129bcbf40652eb9f2f61becf3332 # pin@v4 | |
| - name: Ensure GitHub actions are valid | |
| run: actionlint -shellcheck "" # run *without* shellcheck | |
| stylecheck: | |
| name: Check code formatting | |
| needs: [ workflowcheck ] | |
| runs-on: ubuntu-latest | |
| container: openquantumsafe/ci-ubuntu-latest:latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # pin@v4 | |
| - name: Ensure code conventions are upheld | |
| run: python3 -m pytest --verbose tests/test_code_conventions.py | |
| - name: Check that doxygen can parse the documentation | |
| run: mkdir build && ./scripts/run_doxygen.sh $(which doxygen) ./docs/.Doxyfile ./build | |
| - name: Validate CBOM | |
| run: scripts/validate_cbom.sh | |
| upstreamcheck: | |
| name: Check upstream code is properly integrated | |
| needs: [ workflowcheck ] | |
| runs-on: ubuntu-latest | |
| container: openquantumsafe/ci-ubuntu-latest:latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # pin@v4 | |
| - name: Configure | |
| run: | | |
| git config --global user.name "ciuser" && \ | |
| git config --global user.email "[email protected]" && \ | |
| git config --global --add safe.directory "$PWD" && \ | |
| echo "LIBOQS_DIR=$PWD" >> "$GITHUB_ENV" | |
| - name: Verify copy_from_upstream state after copy | |
| working-directory: 'scripts/copy_from_upstream' | |
| run: | | |
| python3 copy_from_upstream.py copy && \ | |
| ! git status | grep -i modified | |
| - name: Verify copy_from_upstream state after libjade | |
| working-directory: 'scripts/copy_from_upstream' | |
| run: | | |
| python3 copy_from_upstream.py libjade && \ | |
| ! git status | grep -i modified | |
| buildcheck: | |
| name: Check that code passes a basic build | |
| needs: [ workflowcheck, stylecheck, upstreamcheck ] | |
| runs-on: ubuntu-latest | |
| container: openquantumsafe/ci-ubuntu-latest:latest | |
| env: | |
| KEM_NAME: ml_kem_768 | |
| SIG_NAME: ml_dsa_65 | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # pin@v4 | |
| - name: Configure | |
| run: | | |
| mkdir build && \ | |
| cd build && \ | |
| cmake -GNinja -DOQS_STRICT_WARNINGS=ON \ | |
| -GNinja \ | |
| -DOQS_MINIMAL_BUILD="KEM_$KEM_NAME;SIG_$SIG_NAME" \ | |
| --warn-uninitialized .. > config.log 2>&1 && \ | |
| cat config.log && \ | |
| cmake -LA -N .. && \ | |
| ! (grep -i "uninitialized variable" config.log) | |
| - name: Build code | |
| run: ninja | |
| working-directory: build | |
| - name: Build documentation | |
| run: ninja gen_docs | |
| working-directory: build |