docs: Add submodule initialization instructions to README #1513
Workflow file for this run
This file contains hidden or 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: "build" | |
| on: | |
| pull_request: | |
| paths: | |
| - ".github/workflows/build.yaml" | |
| - "CMakeLists.txt" | |
| - "examples/**/*" | |
| - "src/**/*" | |
| - "taskfile.yaml" | |
| - "taskfiles/**/*" | |
| - "tests/**/*" | |
| push: | |
| paths: | |
| - ".github/workflows/build.yaml" | |
| - "CMakeLists.txt" | |
| - "examples/**/*" | |
| - "src/**/*" | |
| - "taskfile.yaml" | |
| - "taskfiles/**/*" | |
| - "tests/**/*" | |
| workflow_call: | |
| concurrency: | |
| group: "${{github.workflow}}-${{github.ref}}" | |
| # Cancel in-progress jobs for efficiency | |
| cancel-in-progress: true | |
| jobs: | |
| build: | |
| strategy: | |
| matrix: | |
| os: | |
| - "macos-15" | |
| - "ubuntu-22.04" | |
| - "ubuntu-24.04" | |
| build_type: | |
| - "debug" | |
| - "release" | |
| runs-on: "${{matrix.os}}" | |
| steps: | |
| - uses: "actions/checkout@v4" | |
| with: | |
| submodules: "recursive" | |
| - name: "Install task" | |
| shell: "bash" | |
| run: "npm install -g @go-task/cli" | |
| - name: "Install uv" | |
| shell: "bash" | |
| run: |- | |
| curl \ | |
| --fail \ | |
| --location \ | |
| --silent \ | |
| --show-error \ | |
| https://astral.sh/uv/0.8.4/install.sh \ | |
| | sh | |
| - name: "Build and run unit tests" | |
| run: "task test:run-${{matrix.build_type}}" | |
| - name: "Print test log on failure" | |
| if: "failure()" | |
| run: "cat ./build/log-surgeon/Testing/Temporary/LastTest.log" | |
| - name: "Build and run examples" | |
| run: |- | |
| task examples:build-${{matrix.build_type}} | |
| ./build/examples/${{matrix.build_type}}/buffer-parser ./examples/schema.txt README.md | |
| ./build/examples/${{matrix.build_type}}/reader-parser ./examples/schema.txt README.md | |
| ./build/examples/${{matrix.build_type}}/intersect-test |