merge dev branch #1
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: Documentation | |
| on: | |
| push: | |
| branches: | |
| - master | |
| tags: '*' | |
| pull_request: | |
| jobs: | |
| check_ongoingjob: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Cancel ongoing documentation builds for previous commits | |
| uses: styfle/[email protected] | |
| with: | |
| access_token: ${{ github.token }} | |
| report_testcoverage: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - uses: julia-actions/setup-julia@latest | |
| with: | |
| version: '1.7' | |
| - uses: julia-actions/julia-buildpkg@latest | |
| - uses: julia-actions/julia-runtest@latest | |
| - uses: julia-actions/julia-processcoverage@v1 | |
| - name: Setup .NET Core # Required to execute ReportGenerator | |
| uses: actions/setup-dotnet@v3 | |
| with: | |
| dotnet-version: 8.x | |
| dotnet-quality: 'ga' | |
| - name: ReportGenerator | |
| uses: danielpalme/[email protected] | |
| with: | |
| reports: 'lcov.info' # REQUIRED # The coverage reports that should be parsed (separated by semicolon). Globbing is supported. | |
| targetdir: 'docs/src/coverage' # REQUIRED # The directory where the generated report should be saved. | |
| reporttypes: 'HtmlInline;Cobertura' # The output formats and scope (separated by semicolon) Values: Badges, Clover, Cobertura, OpenCover, CsvSummary, Html, Html_Dark, Html_Light, Html_BlueRed, HtmlChart, HtmlInline, HtmlInline_AzurePipelines, HtmlInline_AzurePipelines_Dark, HtmlInline_AzurePipelines_Light, HtmlSummary, Html_BlueRed_Summary, JsonSummary, CodeClimate, Latex, LatexSummary, lcov, MarkdownSummary, MarkdownSummaryGithub, MarkdownDeltaSummary, MHtml, SvgChart, SonarQube, TeamCitySummary, TextSummary, TextDeltaSummary, Xml, XmlSummary | |
| sourcedirs: '' # Optional directories which contain the corresponding source code (separated by semicolon). The source directories are used if coverage report contains classes without path information. | |
| verbosity: 'Info' # The verbosity level of the log messages. Values: Verbose, Info, Warning, Error, Off | |
| title: '' # Optional title. | |
| tag: '${{ github.run_number }}_${{ github.run_id }}' # Optional tag or build version. | |
| toolpath: 'reportgeneratortool' # Default directory for installing the dotnet tool. | |
| # generate Documentor | |
| - name: Instantiate and install dependencies | |
| run: | | |
| julia --project=docs -e ' | |
| using Pkg | |
| Pkg.develop(PackageSpec(path=pwd())) | |
| Pkg.instantiate()' | |
| - name: Generate documentation and deploy | |
| env: # needed for pushing to gh-pages branch | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} | |
| run: | |
| julia --project=docs docs/make.jl |