Merge pull request #1106 from alan-turing-institute/ablaom-patch-1 #770
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: | |
| branches: | |
| - master | |
| - dev | |
| - for-a-0-point-18-release | |
| push: | |
| branches: | |
| - master | |
| - dev | |
| tags: '*' | |
| permissions: | |
| contents: read | |
| jobs: | |
| test: | |
| name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }} | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| version: | |
| - '1' # automatically expands to the latest stable 1.x release of Julia. | |
| os: | |
| - ubuntu-latest | |
| arch: # TODO: delete the `arch` | |
| - x64 # TODO: delete the `arch` | |
| steps: | |
| - name: Determine if PR is from a fork | |
| run: | | |
| echo "head_ref is: ${{ github.head_ref }}" | |
| echo "target repository is: ${{ github.repository }}" | |
| echo "head repository is: ${{ github.event.pull_request.head.repo.full_name }}" | |
| - uses: actions/checkout@v2 | |
| - uses: julia-actions/setup-julia@v1 | |
| with: | |
| version: ${{ matrix.version }} | |
| - uses: julia-actions/cache@v1 | |
| - uses: julia-actions/julia-buildpkg@v1 | |
| - uses: julia-actions/julia-runtest@v1 | |
| - uses: julia-actions/julia-processcoverage@v1 | |
| - uses: codecov/codecov-action@v1 | |
| with: | |
| file: lcov.info | |
| integration: | |
| # This job (the `integration` job) has a conditional (`if:`) with the following | |
| # three conditions: | |
| # | |
| # 1. Make sure that this is a PR: | |
| # github.event_name == 'pull_request' | |
| # | |
| # 2. Make sure that the PR head branch is `dev`: | |
| # github.head_ref == 'dev' | |
| # | |
| # 3. Make sure that the PR is NOT from a fork: | |
| # github.repository == github.event.pull_request.head.repo.full_name | |
| if: (github.event_name == 'pull_request') && (github.head_ref == 'dev') && (github.repository == github.event.pull_request.head.repo.full_name) | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| version: | |
| - '1' # automatically expands to the latest stable 1.x release of Julia. | |
| os: | |
| - 'ubuntu-latest' | |
| steps: | |
| - uses: actions/checkout@v2 | |
| with: | |
| persist-credentials: false | |
| - uses: julia-actions/setup-julia@v1 | |
| with: | |
| version: ${{ matrix.version }} | |
| - uses: julia-actions/cache@v1 | |
| - uses: julia-actions/julia-buildpkg@v1 | |
| - uses: julia-actions/julia-runtest@v1 | |
| env: | |
| # This environment variable enables the integration tests: | |
| MLJ_TEST_INTEGRATION: '1' | |
| - uses: julia-actions/julia-processcoverage@v1 | |
| - uses: codecov/codecov-action@v1 | |
| with: | |
| file: lcov.info | |
| docs: | |
| name: Documentation | |
| runs-on: ubuntu-latest | |
| env: | |
| JULIA_PKG_SERVER: "" | |
| steps: | |
| - uses: actions/checkout@v2 | |
| with: | |
| persist-credentials: false | |
| - uses: julia-actions/setup-julia@v1 | |
| with: | |
| version: '1' | |
| - run: | | |
| julia -e ' | |
| function set_environment_variable(name::AbstractString, value::AbstractString) | |
| github_env = ENV["GITHUB_ENV"] | |
| touch(github_env) | |
| open(github_env, "a") do io | |
| println(io, "$(name)=$(value)") | |
| end | |
| end | |
| event_name = "${{ github.event_name }}" | |
| if event_name == "pull_request" | |
| base_ref = "${{ github.base_ref }}" | |
| head_ref = "${{ github.head_ref }}" | |
| base_repository = "${{ github.repository }}" | |
| head_repository = "${{ github.event.pull_request.head.repo.full_name }}" | |
| build_docs = (base_ref == "master") && (head_ref == "dev") && (base_repository == head_repository) | |
| elseif event_name == "push" | |
| ref = "${{ github.ref }}" | |
| build_docs = (ref == "refs/heads/master") || (startswith(ref, "refs/tags/")) | |
| elseif event_name == "schedule" | |
| build_docs = ref == "refs/heads/master" | |
| elseif event_name == "workflow_dispatch" | |
| build_docs = ref == "refs/heads/master" | |
| else | |
| build_docs = false | |
| end | |
| if build_docs | |
| @info("We will build the docs") | |
| set_environment_variable("BUILD_DOCS", "true") | |
| else | |
| @info("We will NOT build the docs") | |
| set_environment_variable("BUILD_DOCS", "false") | |
| end' | |
| - run: | | |
| if ENV["BUILD_DOCS"] == "true" | |
| using Pkg | |
| Pkg.develop(PackageSpec(path=pwd())) | |
| Pkg.instantiate() | |
| end | |
| shell: julia --color=yes --project=docs {0} | |
| - run: | | |
| if ENV["BUILD_DOCS"] == "true" | |
| @info "attempting to build the docs" | |
| run(`julia --project=docs docs/make.jl`) | |
| @info "successfully built the docs" | |
| else | |
| @info "skipping the docs build" | |
| end | |
| shell: julia --color=yes --project=docs {0} | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} |