diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index ad12077d9..342eb8583 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -6,6 +6,26 @@ on: workflow_dispatch: jobs: + # Ensure that the zig version found in build.zig.zon is present in the readme + readme-version: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v7 + - run: | + DOC_FILES="README.md website/content/docs/getting-started.smd" + EXIT_CODE=0 + for FILE in $DOC_FILES + do + if ! grep -q $(cat build.zig.zon | sed -n 's/.*\.minimum_zig_version = "\(.*\)",/\1/p') $FILE + then + echo Zig version documented in \'$FILE'\ out of sync with build.zig.zon + EXIT_CODE=1 + fi + done + + exit $EXIT_CODE + lint: runs-on: ubuntu-latest permissions: diff --git a/README.md b/README.md index f7f025081..f29b88d4b 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ ## What version of Zig to use -`0.17.0-dev.1471+ff10b90bc` +`0.17.0-dev.1936+5a625d5f3` ## Getting Started With MicroZig diff --git a/website/content/docs/getting-started.smd b/website/content/docs/getting-started.smd index 91ade1b9c..0b2181b54 100644 --- a/website/content/docs/getting-started.smd +++ b/website/content/docs/getting-started.smd @@ -28,7 +28,7 @@ The main change is in your `build.zig`, where the board target should be ## Let's Begin Quickly check that you have Zig master. You should see something like -`0.17.0-dev.1158+1d1193aa7` by running `zig version`. +`0.17.0-dev.1936+5a625d5f3` by running `zig version`. Assuming you've initialized a zig project with `zig init`, or have set one up yourself, you can add microzig as a dependency with the following command: