Merge pull request #311 from UNFmontreal/doc_new-features #318
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: Publish documentation | |
| # Controls when the workflow will run | |
| on: | |
| push: | |
| branches: | |
| - master | |
| - dev | |
| tags: | |
| - '[0-9]+.[0-9]+.[0-9]+' | |
| release: | |
| types: [published] | |
| # Allow this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| jobs: | |
| build: | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.11" | |
| - name: Upgrade pip | |
| run: | | |
| # install pip=>20.1 to use "pip cache dir" | |
| python3 -m pip install --upgrade pip | |
| - name: Get pip cache dir | |
| id: pip-cache | |
| run: echo "::set-output name=dir::$(pip cache dir)" | |
| - name: Cache dependencies | |
| uses: actions/cache@v2 | |
| with: | |
| path: ${{ steps.pip-cache.outputs.dir }} | |
| key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements-doc.txt') }} | |
| restore-keys: | | |
| ${{ runner.os }}-pip- | |
| - name: Install dependencies | |
| run: | | |
| python3 -m pip install -r ./requirements-doc.txt | |
| pip install -e . | |
| dcm2bids -h > docs_helper/help.txt | |
| dcm2bids_helper -h > docs_helper/helper.txt | |
| dcm2bids_scaffold -h > docs_helper/help_scaffold.txt | |
| echo "export VERSION=$(dcm2bids -v | awk '/dcm2bids/ {print $3}')" > docs_helper/version.txt | |
| - name: Set git credentials | |
| run: | | |
| git config --global user.name "${{ github.actor }}" | |
| git config --global user.email "${{ github.actor }}@users.noreply.github.com" | |
| - name: Build API reference | |
| run: pdocs as_markdown -o docs/ dcm2bids --overwrite | |
| - name: Build docs for new release | |
| if: github.event_name == 'release' | |
| run: | | |
| echo "Version: $(dcm2bids -v | awk '/dcm2bids/ {print $3}')" | |
| echo "Version: ${{ github.ref_name }}" | |
| mike deploy -p ${{ github.ref_name }} latest -u | |
| # This might be also triggered for new release as it pushes a new tag, | |
| # but it's ok even if there is an error on this run, the previous run is ok. | |
| - name: Build docs for releases already deployed | |
| if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/') | |
| run: | | |
| echo "Version: $(dcm2bids -v | awk '/dcm2bids/ {print $3}')" | |
| echo "Version: ${{ github.ref_name }}" | |
| mike deploy -p ${{ github.ref_name }} | |
| - name: Deploy dev version | |
| if: ${{ github.ref == 'refs/heads/dev' }} | |
| run: | | |
| VERSION=$(dcm2bids -v | awk '/dcm2bids/ {print $3}') | |
| echo "Version: $VERSION" | |
| mike deploy -p $VERSION dev -u |