update docstrings and api page of the docs #140
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: CI | |
| on: | |
| pull_request: | |
| types: [opened, synchronize, reopened, ready_for_review] | |
| branches: | |
| - main | |
| push: | |
| branches: | |
| - main | |
| tags: '*' | |
| jobs: | |
| fail_if_pull_request_is_draft: | |
| if: github.event.pull_request.draft == true | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Automatic fail for draft PR. | |
| run: exit 1 | |
| test: | |
| if: github.event.pull_request.draft == false | |
| name: Tests, Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }} | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| version: | |
| - '1' | |
| os: [ubuntu-latest] # , windows-latest, macos-latest] | |
| arch: | |
| - x64 | |
| steps: | |
| # Cancel ongoing CI test runs if pushing to branch again before the previous tests | |
| # have finished | |
| - name: Cancel ongoing test runs for previous commits | |
| uses: styfle/[email protected] | |
| with: | |
| access_token: ${{ github.token }} | |
| # Do tests | |
| - uses: actions/checkout@v3 | |
| - uses: julia-actions/setup-julia@v1 | |
| with: | |
| version: ${{ matrix.version }} | |
| arch: ${{ matrix.arch }} | |
| - uses: actions/cache@v3 | |
| env: | |
| cache-name: cache-artifacts | |
| with: | |
| path: ~/.julia/artifacts | |
| key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }} | |
| restore-keys: | | |
| ${{ runner.os }}-test-${{ env.cache-name }}- | |
| ${{ runner.os }}-test- | |
| ${{ runner.os }}- | |
| - uses: julia-actions/julia-buildpkg@latest | |
| - uses: julia-actions/julia-runtest@latest | |
| - uses: julia-actions/julia-processcoverage@v1 | |
| - uses: codecov/codecov-action@v3 | |
| with: | |
| file: lcov.info |