modflowapi 0.2.0 #6
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: Release | |
| on: | |
| push: | |
| branches: | |
| - main | |
| - v[0-9]+.[0-9]+.[0-9]+* | |
| release: | |
| types: | |
| - published | |
| jobs: | |
| prep: | |
| name: Prepare release | |
| runs-on: ubuntu-latest | |
| if: ${{ github.event_name == 'push' && github.ref_name != 'main' }} | |
| permissions: | |
| contents: write | |
| pull-requests: write | |
| defaults: | |
| run: | |
| shell: bash | |
| steps: | |
| - name: Checkout release branch | |
| uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 | |
| - name: Setup Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: 3.8 | |
| cache: 'pip' | |
| cache-dependency-path: pyproject.toml | |
| - name: Install Python dependencies | |
| run: | | |
| pip install --upgrade pip | |
| pip install build twine | |
| pip install . | |
| pip install ".[lint, test]" | |
| - name: Update version | |
| id: version | |
| run: | | |
| ref="${{ github.ref_name }}" | |
| version="${ref#"v"}" | |
| python scripts/update_version.py -v "$version" | |
| python -c "import modflowapi; print('Version: ', modflowapi.__version__)" | |
| echo "version=$version" >> $GITHUB_OUTPUT | |
| - name: Touch changelog | |
| run: touch HISTORY.md | |
| - name: Generate changelog | |
| id: cliff | |
| uses: orhun/git-cliff-action@v1 | |
| with: | |
| config: cliff.toml | |
| args: --verbose --unreleased --tag ${{ steps.version.outputs.version }} | |
| env: | |
| OUTPUT: CHANGELOG.md | |
| - name: Update changelog | |
| run: | | |
| # substitute full group names | |
| sed -i 's/#### Ci/#### Continuous integration/' CHANGELOG.md | |
| sed -i 's/#### Feat/#### New features/' CHANGELOG.md | |
| sed -i 's/#### Fix/#### Bug fixes/' CHANGELOG.md | |
| sed -i 's/#### Refactor/#### Refactoring/' CHANGELOG.md | |
| sed -i 's/#### Test/#### Testing/' CHANGELOG.md | |
| # prepend release changelog to cumulative changelog | |
| clog="HISTORY.md" | |
| temp="temp.md" | |
| echo "$(tail -n +2 $clog)" > $clog | |
| cat CHANGELOG.md $clog > $temp | |
| sudo mv $temp $clog | |
| sed -i '1i # Changelog' $clog | |
| - name: Upload changelog | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: changelog | |
| path: CHANGELOG.md | |
| - name: Format Python files | |
| run: python scripts/pull_request_prepare.py | |
| - name: Push release branch | |
| env: | |
| GITHUB_TOKEN: ${{ github.token }} | |
| run: | | |
| ver="${{ steps.version.outputs.version }}" | |
| changelog=$(cat CHANGELOG.md | grep -v "### Version $ver") | |
| # remove this release's changelog so we don't commit it | |
| # the changes have already been prepended to HISTORY.md | |
| rm -f CHANGELOG.md | |
| # commit and push changes | |
| git config core.sharedRepository true | |
| git config user.name "github-actions[bot]" | |
| git config user.email "41898282+github-actions[bot]@users.noreply.github.com" | |
| git add -A | |
| git commit -m "ci(release): set version to ${{ steps.version.outputs.version }}, update changelog" | |
| git push origin "${{ github.ref_name }}" | |
| title="Release $ver" | |
| body=' | |
| # Release '$ver' | |
| The release can be approved by merging this pull request into `main`. This will trigger jobs to publish the release to PyPI and reset `develop` from `main`, incrementing the minor version number. | |
| ## Changelog | |
| '$changelog' | |
| ' | |
| gh pr create -B "main" -H "${{ github.ref_name }}" --title "$title" --draft --body "$body" | |
| release: | |
| name: Draft release | |
| # runs only when changes are merged to main | |
| if: ${{ github.event_name == 'push' && github.ref_name == 'main' }} | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write | |
| pull-requests: write | |
| steps: | |
| - name: Checkout repo | |
| uses: actions/checkout@v3 | |
| with: | |
| ref: main | |
| - name: Setup Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: 3.8 | |
| - name: Install Python dependencies | |
| run: | | |
| pip install --upgrade pip | |
| pip install . | |
| pip install ".[test]" | |
| # actions/download-artifact won't look at previous workflow runs but we need to in order to get changelog | |
| - name: Download artifacts | |
| uses: dawidd6/action-download-artifact@v2 | |
| - name: Draft release | |
| env: | |
| GITHUB_TOKEN: ${{ github.token }} | |
| run: | | |
| version=$(python scripts/update_version.py -g) | |
| title="modflowapi $version" | |
| notes=$(cat "changelog/CHANGELOG.md" | grep -v "### Version $version") | |
| gh release create "$version" \ | |
| --target main \ | |
| --title "$title" \ | |
| --notes "$notes" \ | |
| --draft \ | |
| --latest | |
| publish: | |
| name: Publish package | |
| # runs only after release is published (manually promoted from draft) | |
| if: github.event_name == 'release' && github.repository_owner == 'MODFLOW-USGS' | |
| runs-on: ubuntu-22.04 | |
| permissions: | |
| contents: write | |
| pull-requests: write | |
| id-token: write | |
| environment: # requires a 'release' environment in repo settings | |
| name: release | |
| url: https://pypi.org/p/modflowapi | |
| steps: | |
| - name: Checkout main branch | |
| uses: actions/checkout@v3 | |
| with: | |
| ref: main | |
| - name: Setup Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: 3.8 | |
| - name: Install Python dependencies | |
| run: | | |
| pip install --upgrade pip | |
| pip install build twine | |
| pip install . | |
| - name: Build package | |
| run: python -m build | |
| - name: Check package | |
| run: twine check --strict dist/* | |
| - name: Upload package | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: dist | |
| path: dist | |
| - name: Publish to PyPI | |
| uses: pypa/gh-action-pypi-publish@release/v1 |