Code block highlighting/formatting #5
Workflow file for this run
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: Literate check | |
| on: | |
| push: | |
| branches: [main] | |
| tags: [v*] | |
| pull_request: | |
| jobs: | |
| literate: | |
| name: "Literate Check" | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: julia-actions/setup-julia@v2 | |
| with: | |
| version: 1 | |
| - name: Install Literate and generate docs | |
| run: | | |
| julia -e 'using Pkg; Pkg.add(PackageSpec(name="Literate"))' | |
| julia -e 'using Literate; Literate.markdown("examples/README.jl", "docs/src"; flavor=Literate.DocumenterFlavor(), name="index")' | |
| - name: Check if docs need to be updated | |
| run: | | |
| julia -e ' | |
| out = Cmd(`git diff --name-only`) |> read |> String | |
| if out == "" | |
| exit(0) | |
| else | |
| @error "The documentation is outdated, rerun Literate to regenerate them." | |
| write(stdout, out) | |
| out_diff = Cmd(`git diff`) |> read |> String | |
| @error "Diff:" | |
| write(stdout, out_diff) | |
| exit(1) | |
| @error "" | |
| end' |