docs #166
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/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 | |
| schedule: | |
| - cron: '0 0 * * 0' # run at midnight every Sunday | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.head_ref || github.ref }} | |
| cancel-in-progress: true | |
| env: | |
| XUVTOP: /tmp/chianti | |
| CHIANTI_DL_URL: https://download.chiantidatabase.org | |
| CHIANTI_DB_VER: CHIANTI_v9.0.1_database.tar.gz | |
| CMFGEN_DL_URL: http://kookaburra.phyast.pitt.edu/hillier/cmfgen_files | |
| CMFGEN_DB_VER: atomic_data_15nov16.tar.gz | |
| DEPLOY_BRANCH: gh-pages # deployed docs branch | |
| jobs: | |
| build: | |
| 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@v4 | |
| with: | |
| fetch-depth: 0 | |
| - uses: actions/cache@v2 | |
| with: | |
| path: ${{ env.XUVTOP }} | |
| key: ${{ env.CHIANTI_DB_VER }} | |
| id: chianti-cache | |
| - name: Download Chianti database | |
| run: | | |
| mkdir -p ${{ env.XUVTOP }} | |
| wget -q ${{ env.CHIANTI_DL_URL }}/${{ env.CHIANTI_DB_VER }} -O ${{ env.XUVTOP }}/chianti.tar.gz | |
| tar -zxf ${{ env.XUVTOP }}/chianti.tar.gz -C ${{ env.XUVTOP }} --warning=none | |
| if: steps.chianti-cache.outputs.cache-hit != 'true' | |
| - uses: actions/cache@v2 | |
| with: | |
| path: /tmp/atomic | |
| key: ${{ env.CMFGEN_DB_VER }} | |
| id: cmfgen-cache | |
| - name: Download CMFGEN database | |
| run: | | |
| wget -q -U "Mozilla/4.0" ${{ env.CMFGEN_DL_URL }}/${{ env.CMFGEN_DB_VER }} -O /tmp/atomic.tar.gz | |
| tar -zxf /tmp/atomic.tar.gz -C /tmp | |
| if: steps.cmfgen-cache.outputs.cache-hit != 'true' | |
| - uses: mamba-org/setup-micromamba@v1 | |
| with: | |
| environment-file: conda-lock.yml | |
| init-shell: bash | |
| cache-environment: true | |
| cache-downloads: true | |
| environment-name: carsus | |
| - name: Install package | |
| shell: bash -l {0} | |
| run: pip install -e . | |
| - name: Build documentation | |
| shell: bash -l {0} | |
| run: cd docs/; make html | |
| - 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.GITHUB_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: 'Github Actions' | |
| user_email: '41898282+github-actions[bot]@users.noreply.github.com' | |
| - 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.GITHUB_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 }}/ | |
| if: success() && github.event_name == 'pull_request_target' | |
| - name: Post comment (failure) | |
| uses: peter-evans/create-or-update-comment@v1 | |
| with: | |
| token: ${{ secrets.GITHUB_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' |