BarPlugin YAML config #156
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: docs-commit | |
| on: | |
| pull_request: | |
| paths: | |
| - .github/workflows/docs_commit.yml | |
| - docs/** | |
| - toc.yml | |
| - src/** | |
| env: | |
| # We install the packages to the D:\ drive to avoid the slow IO on the C:\ drive. | |
| # Based on https://github.com/actions/setup-dotnet/issues/260#issuecomment-1790162905 | |
| NUGET_PACKAGES: D:\a\.nuget\packages | |
| PLATFORM: x64 | |
| CONFIGURATION: Release | |
| jobs: | |
| lint: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Run markdownlint | |
| uses: DavidAnson/markdownlint-cli2-action@v17 | |
| with: | |
| config: .markdownlint-cli2.jsonc | |
| globs: | | |
| **/*.md | |
| !.github/**/*.md | |
| build: | |
| # Run on Windows since docfx will build Whim to generate the API docs. | |
| runs-on: windows-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Cache NuGet packages | |
| uses: actions/cache@v4 | |
| with: | |
| path: ${{ env.NUGET_PACKAGES }} | |
| key: ${{ env.PLATFORM }}-nuget-${{ hashFiles('Directory.Packages.props') }} | |
| restore-keys: | | |
| ${{ env.PLATFORM }}-nuget-${{ hashFiles('Directory.Packages.props') }} | |
| ${{ env.PLATFORM }}-nuget- | |
| - name: Restore dependencies | |
| run: | | |
| dotnet restore Whim.sln -p:Configuration=$env:Configuration | |
| env: | |
| Configuration: ${{ env.CONFIGURATION }} | |
| - name: Install dotnet tools | |
| run: | | |
| dotnet tool restore | |
| - name: Build schema | |
| run: | | |
| .\scripts\Generate-SourceFromSchema.ps1 | |
| - name: Run docfx | |
| run: dotnet docfx .\docs\docfx.json |