Update plasma configuration documentation (#2459) #2904
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
| # For more information about TARDIS pipelines, please refer to: | |
| # | |
| # https://tardis-sn.github.io/tardis/contributing/development/continuous_integration.html | |
| name: docs | |
| on: | |
| push: | |
| branches: | |
| - master | |
| pull_request_target: | |
| branches: | |
| - master | |
| types: | |
| - opened | |
| - reopened | |
| - synchronize | |
| - labeled # requires the `build-docs` label | |
| workflow_dispatch: # manual trigger | |
| env: | |
| CACHE_NUMBER: 0 # increase to reset cache manually | |
| DEPLOY_BRANCH: gh-pages # deployed docs branch | |
| HDF5_USE_FILE_LOCKING: 'FALSE' # disable file locking | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.head_ref || github.ref }} | |
| cancel-in-progress: true | |
| defaults: | |
| run: | |
| shell: bash -l {0} | |
| jobs: | |
| build-docs: | |
| if: github.event_name == 'push' || | |
| github.event_name == 'workflow_dispatch' || | |
| (github.event_name == 'pull_request_target' && | |
| contains(github.event.pull_request.labels.*.name, 'build-docs')) | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| if: github.event_name != 'pull_request_target' | |
| - name: Checkout pull/${{ github.event.number }} | |
| uses: actions/checkout@v2 | |
| with: | |
| ref: ${{ github.event.pull_request.head.sha }} | |
| if: github.event_name == 'pull_request_target' | |
| - name: Setup environment | |
| uses: conda-incubator/setup-miniconda@v2 | |
| with: | |
| miniforge-variant: Mambaforge | |
| miniforge-version: latest | |
| activate-environment: tardis | |
| use-mamba: true | |
| - uses: actions/cache@v2 | |
| with: | |
| path: /usr/share/miniconda3/envs/tardis | |
| key: conda-linux-64-${{ hashFiles('conda-linux-64.lock') }}-${{ env.CACHE_NUMBER }} | |
| id: cache-conda | |
| - name: Update environment | |
| run: mamba update -n tardis --file conda-linux-64.lock | |
| if: steps.cache-conda.outputs.cache-hit != 'true' | |
| - name: Install package | |
| run: pip install -e . | |
| - name: Build documentation | |
| run: cd docs/ && make html NCORES=auto | |
| - name: Set destination directory | |
| run: | | |
| BRANCH=$(echo ${GITHUB_REF#refs/heads/}) | |
| if [[ $EVENT == push ]] || [[ $EVENT == workflow_dispatch ]]; then | |
| if [[ $BRANCH == $DEFAULT ]]; then | |
| echo "DEST_DIR=" >> $GITHUB_ENV | |
| else | |
| echo "DEST_DIR=branch/$BRANCH" >> $GITHUB_ENV | |
| fi | |
| elif [[ $EVENT == pull_request_target ]]; then | |
| echo "DEST_DIR=pull/$PR" >> $GITHUB_ENV | |
| else | |
| echo "Unexpected event trigger $EVENT" | |
| exit 1 | |
| fi | |
| cat $GITHUB_ENV | |
| env: | |
| DEFAULT: ${{ github.event.repository.default_branch }} | |
| EVENT: ${{ github.event_name }} | |
| PR: ${{ github.event.number }} | |
| - name: Set clean branch option | |
| run: | | |
| if [[ $EVENT == workflow_dispatch ]]; then | |
| echo "CLEAN_BRANCH=true" >> $GITHUB_ENV | |
| else | |
| echo "CLEAN_BRANCH=false" >> $GITHUB_ENV | |
| fi | |
| cat $GITHUB_ENV | |
| env: | |
| EVENT: ${{ github.event_name }} | |
| - name: Deploy ${{ env.DEST_DIR }} | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.BOT_TOKEN }} | |
| publish_branch: ${{ env.DEPLOY_BRANCH }} | |
| publish_dir: ./docs/_build/html | |
| destination_dir: ${{ env.DEST_DIR }} | |
| keep_files: true | |
| force_orphan: ${{ env.CLEAN_BRANCH }} | |
| user_name: 'TARDIS Bot' | |
| user_email: '[email protected]' | |
| - name: Find comment | |
| uses: peter-evans/find-comment@v1 | |
| id: fc | |
| with: | |
| issue-number: ${{ github.event.number }} | |
| body-includes: Hi, human. | |
| if: always() && github.event_name == 'pull_request_target' | |
| - name: Post comment (success) | |
| uses: peter-evans/create-or-update-comment@v1 | |
| with: | |
| token: ${{ secrets.BOT_TOKEN }} | |
| issue-number: ${{ github.event.number }} | |
| comment-id: ${{ steps.fc.outputs.comment-id }} | |
| edit-mode: replace | |
| body: | | |
| *\*beep\* \*bop\** | |
| Hi, human. | |
| The **`${{ github.workflow }}`** workflow has **succeeded** :heavy_check_mark: | |
| [**Click here**](${{ env.URL }}) to see your results. | |
| env: | |
| URL: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/pull/${{ github.event.number }}/index.html | |
| if: success() && github.event_name == 'pull_request_target' | |
| - name: Post comment (failure) | |
| uses: peter-evans/create-or-update-comment@v1 | |
| with: | |
| token: ${{ secrets.BOT_TOKEN }} | |
| issue-number: ${{ github.event.number }} | |
| comment-id: ${{ steps.fc.outputs.comment-id }} | |
| edit-mode: replace | |
| body: | | |
| *\*beep\* \*bop\** | |
| Hi, human. | |
| The **`${{ github.workflow }}`** workflow has **failed** :x: | |
| [**Click here**](${{ env.URL }}) to see the build log. | |
| env: | |
| URL: https://github.com/${{ github.repository_owner }}/${{ github.event.repository.name }}/actions/runs/${{ github.run_id }}?check_suite_focus=true | |
| if: failure() && github.event_name == 'pull_request_target' |