forked from GenericMappingTools/pygmt
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Separate workflows for running tests and building documentation (Gene…
…ricMappingTools#1033) Separates the current "Tests" workflow into two workflows to speedup our CI jobs. - ci_test.yaml: runs the full tests - ci_docs.yml: build the documentation and deploy it on master branch Co-authored-by: Wei Ji <[email protected]>
- Loading branch information
2 people
authored and
Josh Sixsmith
committed
Dec 21, 2022
1 parent
d705ddf
commit 012c2a3
Showing
3 changed files
with
186 additions
and
76 deletions.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,164 @@ | ||
| # This workflow installs PyGMT, builds and deploys documentation | ||
|
|
||
| name: Docs | ||
|
|
||
| on: | ||
| push: | ||
| branches: [ master ] | ||
| pull_request: | ||
| types: [opened, reopened, synchronize, ready_for_review] | ||
| paths-ignore: | ||
| - 'pygmt/tests/**' | ||
| - '*.md' | ||
| - '*.json' | ||
| - 'LICENSE.txt' | ||
| - '.gitignore' | ||
| - '.pylintrc' | ||
| release: | ||
| types: | ||
| - published | ||
|
|
||
| jobs: | ||
| docs: | ||
| name: ${{ matrix.os }} - Python ${{ matrix.python-version }} | ||
| runs-on: ${{ matrix.os }} | ||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| python-version: [3.9] | ||
| os: [ubuntu-latest, macOS-latest, windows-latest] | ||
| # Is it a draft Pull Request (true or false)? | ||
| isDraft: | ||
| - ${{ github.event.pull_request.draft }} | ||
| # Only run one job (Ubuntu + Python 3.9) for draft PRs | ||
| exclude: | ||
| - os: macOS-latest | ||
| isDraft: true | ||
| - os: windows-latest | ||
| isDraft: true | ||
| defaults: | ||
| run: | ||
| shell: bash -l {0} | ||
|
|
||
| steps: | ||
| # Cancel previous runs that are not completed | ||
| - name: Cancel Previous Runs | ||
| uses: styfle/[email protected] | ||
| with: | ||
| access_token: ${{ github.token }} | ||
|
|
||
| # Checkout current git repository | ||
| - name: Checkout | ||
| uses: actions/[email protected] | ||
| with: | ||
| # fecth all history so that setuptools-scm works | ||
| fetch-depth: 0 | ||
|
|
||
| # Setup Miniconda | ||
| - name: Setup Miniconda | ||
| uses: conda-incubator/[email protected] | ||
| with: | ||
| activate-environment: pygmt | ||
| python-version: ${{ matrix.python-version }} | ||
| channels: conda-forge | ||
| miniconda-version: "latest" | ||
|
|
||
| # Install GMT and other required dependencies from conda-forge | ||
| - name: Install dependencies | ||
| run: | | ||
| conda install gmt=6.1.1 numpy pandas xarray netCDF4 packaging \ | ||
| ipython make myst-parser \ | ||
| sphinx sphinx-copybutton sphinx-gallery sphinx_rtd_theme=0.4.3 | ||
| # Show installed pkg information for postmortem diagnostic | ||
| - name: List installed packages | ||
| run: conda list | ||
|
|
||
| # Download cached remote files (artifacts) from GitHub | ||
| - name: Download remote data from GitHub | ||
| uses: dawidd6/[email protected] | ||
| with: | ||
| workflow: cache_data.yaml | ||
| workflow_conclusion: success | ||
| name: gmt-cache | ||
| path: .gmt | ||
|
|
||
| # Move downloaded files to ~/.gmt directory and list them | ||
| - name: Move and list downloaded remote files | ||
| run: | | ||
| mkdir -p ~/.gmt | ||
| mv .gmt/* ~/.gmt | ||
| # Change modification times of the two files, so GMT won't refresh it | ||
| touch ~/.gmt/server/gmt_data_server.txt ~/.gmt/server/gmt_hash_server.txt | ||
| ls -lhR ~/.gmt | ||
| # Install the package that we want to test | ||
| - name: Install the package | ||
| run: | | ||
| python setup.py sdist --formats=zip | ||
| pip install dist/* | ||
| # Build the documentation | ||
| - name: Build the documentation | ||
| run: make -C doc clean all | ||
|
|
||
| - name: Checkout the gh-pages branch | ||
| uses: actions/checkout@28c7f3d2b5162b5ddd3dfd9a45aa55eaf396478b | ||
| with: | ||
| ref: gh-pages | ||
| # Checkout to this folder instead of the current one | ||
| path: deploy | ||
| # Download the entire history | ||
| fetch-depth: 0 | ||
| if: (github.event_name == 'release' || github.event_name == 'push') && (matrix.os == 'ubuntu-latest') | ||
|
|
||
| - name: Push the built HTML to gh-pages | ||
| run: | | ||
| # Detect if this is a release or from the master branch | ||
| if [[ "${GITHUB_EVENT_NAME}" == "release" ]]; then | ||
| # Get the tag name without the "refs/tags/" part | ||
| version="${GITHUB_REF#refs/*/}" | ||
| else | ||
| version=dev | ||
| fi | ||
| echo "Deploying version: $version" | ||
| # Make the new commit message. Needs to happen before cd into deploy | ||
| # to get the right commit hash. | ||
| message="Deploy $version from $(git rev-parse --short HEAD)" | ||
| cd deploy | ||
| # Need to have this file so that Github doesn't try to run Jekyll | ||
| touch .nojekyll | ||
| # Delete all the files and replace with our new set | ||
| echo -e "\nRemoving old files from previous builds of ${version}:" | ||
| rm -rvf ${version} | ||
| echo -e "\nCopying HTML files to ${version}:" | ||
| cp -Rvf ../doc/_build/html/ ${version}/ | ||
| # If this is a new release, update the link from /latest to it | ||
| if [[ "${version}" != "dev" ]]; then | ||
| echo -e "\nSetup link from ${version} to 'latest'." | ||
| rm -f latest | ||
| ln -sf ${version} latest | ||
| fi | ||
| # Stage the commit | ||
| git add -A . | ||
| echo -e "\nChanges to be applied:" | ||
| git status | ||
| # Configure git to be the GitHub Actions account | ||
| git config user.email "github-actions[bot]@users.noreply.github.com" | ||
| git config user.name "github-actions[bot]" | ||
| # If this is a dev build and the last commit was from a dev build | ||
| # (detect if "dev" was in the previous commit message), reuse the | ||
| # same commit | ||
| if [[ "${version}" == "dev" && `git log -1 --format='%s'` == *"dev"* ]]; then | ||
| echo -e "\nAmending last commit:" | ||
| git commit --amend --reset-author -m "$message" | ||
| else | ||
| echo -e "\nMaking a new commit:" | ||
| git commit -m "$message" | ||
| fi | ||
| # Make the push quiet just in case there is anything that could leak | ||
| # sensitive information. | ||
| echo -e "\nPushing changes to gh-pages." | ||
| git push -fq origin gh-pages 2>&1 >/dev/null | ||
| echo -e "\nFinished uploading generated files." | ||
| if: (github.event_name == 'release' || github.event_name == 'push') && (matrix.os == 'ubuntu-latest') |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,4 @@ | ||
| # This workflow installs PyGMT dependencies, build documentation and run tests | ||
| # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions | ||
| # This workflow installs PyGMT and runs tests | ||
|
|
||
| name: Tests | ||
|
|
||
|
|
@@ -10,10 +9,13 @@ on: | |
| types: [opened, reopened, synchronize, ready_for_review] | ||
| paths-ignore: | ||
| - 'doc/**' | ||
| - 'examples/**' | ||
| - '*.md' | ||
| - '*.json' | ||
| - 'README.rst' | ||
| - 'LICENSE.txt' | ||
| - '.gitignore' | ||
| - '.pylintrc' | ||
| release: | ||
| types: | ||
| - published | ||
|
|
@@ -79,7 +81,10 @@ jobs: | |
|
|
||
| # Install GMT and other required dependencies from conda-forge | ||
| - name: Install dependencies | ||
| run: conda env update --file environment.yml | ||
| run: | | ||
| conda install gmt=6.1.1 numpy pandas xarray netCDF4 packaging \ | ||
| codecov coverage[toml] ipython make \ | ||
| pytest-cov pytest-mpl pytest>=6.0 | ||
| # Show installed pkg information for postmortem diagnostic | ||
| - name: List installed packages | ||
|
|
@@ -121,75 +126,10 @@ jobs: | |
| name: artifact-${{ runner.os }}-${{ matrix.python-version }} | ||
| path: tmp-test-dir-with-unique-name | ||
|
|
||
| # Build the documentation | ||
| - name: Build the documentation | ||
| run: make -C doc clean all | ||
|
|
||
| # Upload coverage to Codecov | ||
| - name: Upload coverage to Codecov | ||
| uses: codecov/[email protected] | ||
| with: | ||
| file: ./coverage.xml # optional | ||
| env_vars: OS,PYTHON | ||
| fail_ci_if_error: false | ||
|
|
||
| - name: Checkout the gh-pages branch | ||
| uses: actions/checkout@28c7f3d2b5162b5ddd3dfd9a45aa55eaf396478b | ||
| with: | ||
| ref: gh-pages | ||
| # Checkout to this folder instead of the current one | ||
| path: deploy | ||
| # Download the entire history | ||
| fetch-depth: 0 | ||
| if: (github.event_name == 'release' || github.event_name == 'push') && (matrix.os == 'ubuntu-latest') && (matrix.python-version == '3.9') | ||
|
|
||
| - name: Push the built HTML to gh-pages | ||
| run: | | ||
| # Detect if this is a release or from the master branch | ||
| if [[ "${GITHUB_EVENT_NAME}" == "release" ]]; then | ||
| # Get the tag name without the "refs/tags/" part | ||
| version="${GITHUB_REF#refs/*/}" | ||
| else | ||
| version=dev | ||
| fi | ||
| echo "Deploying version: $version" | ||
| # Make the new commit message. Needs to happen before cd into deploy | ||
| # to get the right commit hash. | ||
| message="Deploy $version from $(git rev-parse --short HEAD)" | ||
| cd deploy | ||
| # Need to have this file so that Github doesn't try to run Jekyll | ||
| touch .nojekyll | ||
| # Delete all the files and replace with our new set | ||
| echo -e "\nRemoving old files from previous builds of ${version}:" | ||
| rm -rvf ${version} | ||
| echo -e "\nCopying HTML files to ${version}:" | ||
| cp -Rvf ../doc/_build/html/ ${version}/ | ||
| # If this is a new release, update the link from /latest to it | ||
| if [[ "${version}" != "dev" ]]; then | ||
| echo -e "\nSetup link from ${version} to 'latest'." | ||
| rm -f latest | ||
| ln -sf ${version} latest | ||
| fi | ||
| # Stage the commit | ||
| git add -A . | ||
| echo -e "\nChanges to be applied:" | ||
| git status | ||
| # Configure git to be the GitHub Actions account | ||
| git config user.email "github-actions[bot]@users.noreply.github.com" | ||
| git config user.name "github-actions[bot]" | ||
| # If this is a dev build and the last commit was from a dev build | ||
| # (detect if "dev" was in the previous commit message), reuse the | ||
| # same commit | ||
| if [[ "${version}" == "dev" && `git log -1 --format='%s'` == *"dev"* ]]; then | ||
| echo -e "\nAmending last commit:" | ||
| git commit --amend --reset-author -m "$message" | ||
| else | ||
| echo -e "\nMaking a new commit:" | ||
| git commit -m "$message" | ||
| fi | ||
| # Make the push quiet just in case there is anything that could leak | ||
| # sensitive information. | ||
| echo -e "\nPushing changes to gh-pages." | ||
| git push -fq origin gh-pages 2>&1 >/dev/null | ||
| echo -e "\nFinished uploading generated files." | ||
| if: (github.event_name == 'release' || github.event_name == 'push') && (matrix.os == 'ubuntu-latest') && (matrix.python-version == '3.9') | ||
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