Enforce strict docs compilation and add Documentation best practices guidelines #1518
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: Format Check | |
on: | |
push: | |
branches: | |
- 'main' | |
- 'release-' | |
tags: '*' | |
pull_request: | |
jobs: | |
build: | |
runs-on: ${{ matrix.os }} | |
strategy: | |
matrix: | |
julia-version: [1] | |
julia-arch: [x86] | |
os: [ubuntu-latest] | |
steps: | |
- uses: julia-actions/setup-julia@latest | |
with: | |
version: ${{ matrix.julia-version }} | |
- uses: actions/checkout@v3 | |
- name: Install JuliaFormatter and format | |
run: | | |
julia -e 'include("scripts/formatter/formatter_code.jl")' | |
- uses: reviewdog/action-suggester@v1 | |
if: github.event_name == 'pull_request' | |
with: | |
tool_name: JuliaFormatter | |
fail_on_error: true | |
- name: Format check | |
run: | | |
julia -e ' | |
out = Cmd(`git diff --name-only`) |> read |> String | |
if out == "" | |
exit(0) | |
else | |
@error "Some files have not been formatted !!!" | |
write(stdout, out) | |
exit(1) | |
end' |