Move to use cruft / conda cookiecutter template #761
Workflow file for this run
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: on-push | |
| on: | |
| push: | |
| branches: | |
| - main | |
| tags: | |
| - '*' | |
| pull_request: | |
| branches: | |
| - main | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| defaults: | |
| run: | |
| shell: bash -l {0} | |
| jobs: | |
| pre-commit: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.x | |
| - uses: pre-commit/[email protected] | |
| combine-environments: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.x | |
| - name: Install conda-merge | |
| run: | | |
| python -m pip install conda-merge | |
| - name: Combine environments | |
| run: | | |
| for SUFFIX in ci integration; do | |
| conda-merge ci/environment-$SUFFIX.yml environment.yml > ci/combined-environment-$SUFFIX.yml || exit | |
| done | |
| - uses: actions/upload-artifact@v4 | |
| with: | |
| name: combined-environments | |
| path: ci/combined-environment-*.yml | |
| unit-tests: | |
| name: unit-tests | |
| needs: combine-environments | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: ['3.11'] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/download-artifact@v4 | |
| with: | |
| name: combined-environments | |
| path: ci | |
| - name: Get current date | |
| id: date | |
| run: echo "date=$(date +%Y-%m-%d)" >> "${GITHUB_OUTPUT}" | |
| - uses: mamba-org/setup-micromamba@v1 | |
| with: | |
| environment-file: ci/combined-environment-ci.yml | |
| environment-name: DEVELOP | |
| cache-environment: true | |
| cache-environment-key: environment-${{ steps.date.outputs.date }} | |
| cache-downloads-key: downloads-${{ steps.date.outputs.date }} | |
| create-args: >- | |
| python=${{ matrix.python-version }} | |
| - name: Install package | |
| run: | | |
| python -m pip install --no-deps -e . | |
| - name: Run tests | |
| run: | | |
| make unit-tests COV_REPORT=xml | |
| type-check: | |
| needs: [combine-environments, unit-tests] | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/download-artifact@v4 | |
| with: | |
| name: combined-environments | |
| path: ci | |
| - name: Get current date | |
| id: date | |
| run: echo "date=$(date +%Y-%m-%d)" >> "${GITHUB_OUTPUT}" | |
| - uses: mamba-org/setup-micromamba@v1 | |
| with: | |
| environment-file: ci/combined-environment-ci.yml | |
| environment-name: DEVELOP | |
| cache-environment: true | |
| cache-environment-key: environment-${{ steps.date.outputs.date }} | |
| cache-downloads-key: downloads-${{ steps.date.outputs.date }} | |
| create-args: >- | |
| python=3.11 | |
| - name: Install package | |
| run: | | |
| python -m pip install --no-deps -e . | |
| - name: Run code quality checks | |
| run: | | |
| make type-check | |
| docs-build: | |
| needs: [combine-environments, unit-tests] | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/download-artifact@v4 | |
| with: | |
| name: combined-environments | |
| path: ci | |
| - name: Get current date | |
| id: date | |
| run: echo "date=$(date +%Y-%m-%d)" >> "${GITHUB_OUTPUT}" | |
| - uses: mamba-org/setup-micromamba@v1 | |
| with: | |
| environment-file: ci/combined-environment-ci.yml | |
| environment-name: DEVELOP | |
| cache-environment: true | |
| cache-environment-key: environment-${{ steps.date.outputs.date }} | |
| cache-downloads-key: downloads-${{ steps.date.outputs.date }} | |
| create-args: >- | |
| python=3.11 | |
| - name: Install package | |
| run: | | |
| python -m pip install --no-deps -e . | |
| - name: Build documentation | |
| run: | | |
| make docs-build | |
| integration-tests: | |
| needs: [combine-environments, unit-tests] | |
| if: | | |
| success() && true | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| include: | |
| - python-version: '3.9' | |
| extra: -integration | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/download-artifact@v4 | |
| with: | |
| name: combined-environments | |
| path: ci | |
| - name: Get current date | |
| id: date | |
| run: echo "date=$(date +%Y-%m-%d)" >> "${GITHUB_OUTPUT}" | |
| - uses: mamba-org/setup-micromamba@v1 | |
| with: | |
| environment-file: ci/combined-environment${{ matrix.extra }}.yml | |
| environment-name: DEVELOP${{ matrix.extra }} | |
| cache-environment: true | |
| cache-environment-key: environment-${{ steps.date.outputs.date }} | |
| cache-downloads-key: downloads-${{ steps.date.outputs.date }} | |
| create-args: >- | |
| python=${{ matrix.python-version }} | |
| - name: Install package | |
| run: | | |
| python -m pip install --no-deps -e . | |
| - name: Run tests | |
| run: | | |
| make unit-tests COV_REPORT=xml | |
| distribution: | |
| runs-on: ubuntu-latest | |
| needs: [unit-tests, type-check, docs-build, integration-tests] | |
| if: | | |
| always() && | |
| needs.unit-tests.result == 'success' && | |
| needs.type-check.result == 'success' && | |
| needs.docs-build.result == 'success' && | |
| (needs.integration-tests.result == 'success' || needs.integration-tests.result == 'skipped') | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.11' | |
| - name: Install package | |
| run: | | |
| python -m pip install --upgrade pip | |
| python -m pip install build twine | |
| - name: Build distribution | |
| run: | | |
| python -m build | |
| - name: Check wheels | |
| run: | | |
| cd dist || exit | |
| python -m pip install xarray_sentinel*.whl || exit | |
| python -m twine check --strict * || exit | |
| python -c "import xarray_sentinel" || exit | |
| cd .. | |
| - uses: actions/upload-artifact@v4 | |
| with: | |
| name: distribution | |
| path: dist | |
| upload-to-pypi: | |
| runs-on: ubuntu-latest | |
| needs: distribution | |
| if: | | |
| always() && | |
| needs.distribution.result == 'success' && | |
| github.event_name == 'push' && | |
| startsWith(github.ref, 'refs/tags') | |
| environment: | |
| name: pypi | |
| url: https://pypi.org/p/xarray-sentinel | |
| permissions: | |
| id-token: write # IMPORTANT: this permission is mandatory for trusted publish | |
| steps: | |
| - uses: actions/download-artifact@v4 | |
| with: | |
| name: distribution | |
| path: dist | |
| - uses: pypa/[email protected] | |
| with: | |
| verbose: true |