Site bug (#96) #403
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: Python CI | |
| on: | |
| push: | |
| branches: [] | |
| paths-ignore: | |
| - 'README.md' | |
| tags: | |
| - 'v*' | |
| pull_request: | |
| branches: [] | |
| paths-ignore: | |
| - 'README.md' | |
| workflow_dispatch: | |
| # Specify concurrency such that only one workflow can run at a time | |
| # * Different workflow files are not affected | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| # Registry for storing Container images | |
| env: | |
| REGISTRY: ghcr.io | |
| IMAGE_NAME: ${{ github.repository }} | |
| # Ensure the GitHub token can remove packages | |
| permissions: | |
| packages: write | |
| jobs: | |
| # bump version | |
| bump-version: | |
| uses: openclimatefix/.github/.github/workflows/[email protected] | |
| secrets: | |
| PAT_TOKEN: ${{ secrets.PAT_TOKEN }} | |
| if: github.ref == 'refs/heads/main' | |
| # Define a dependencies job that runs on all branches and PRs | |
| # * Installs dependencies and caches them | |
| build-venv: | |
| runs-on: ubuntu-latest | |
| container: debian:12-slim | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v3 | |
| # Restore cached virtualenv, if available | |
| # * The pyproject.toml hash is part of the cache key, invalidating | |
| # the cache if the file changes | |
| - name: Restore cached virtualenv | |
| id: restore-cache | |
| uses: actions/cache/restore@v3 | |
| with: | |
| path: .venv | |
| key: ${{ runner.os }}-venv-${{ hashFiles('**/pyproject.toml') }} | |
| # Should mirror the build-venv stage in the Containerfile | |
| - name: Build venv | |
| run: | | |
| apt -qq update && apt -qq install -y python3-venv gcc libpython3-dev | |
| python3 -m venv .venv | |
| .venv/bin/python -m pip install --upgrade -q pip wheel setuptools | |
| if: steps.restore-cache.outputs.cache-hit != 'true' | |
| # Should mirror the build-reqs stage in the Containerfile | |
| # * Except this installs the dev dependencies and binaries as well | |
| - name: Install all dependencies | |
| run: .venv/bin/python -m pip install .[test] | |
| if: steps.restore-cache.outputs.cache-hit != 'true' | |
| # Cache the virtualenv for future runs | |
| - name: Cache virtualenv | |
| uses: actions/cache/save@v3 | |
| with: | |
| path: .venv | |
| key: ${{ steps.restore-cache.outputs.cache-primary-key }} | |
| if: steps.restore-cache.outputs.cache-hit != 'true' | |
| # Define a unittest job that runs on all branches and PRs | |
| test-unit: | |
| runs-on: ubuntu-latest | |
| container: debian:12-slim | |
| needs: build-venv | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v3 | |
| - name: Install libpython3-dev | |
| run: apt -qq update && apt -qq install -y python3-venv libpython3-dev | |
| # Restore cached virtualenv, if available | |
| - name: Restore cached virtualenv | |
| id: restore-cache | |
| uses: actions/cache/restore@v3 | |
| with: | |
| path: .venv | |
| key: ${{ runner.os }}-venv-${{ hashFiles('**/pyproject.toml') }} | |
| fail-on-cache-miss: true | |
| # Run unittests | |
| # * Produce JUnit XML report | |
| - name: Run unit tests | |
| run: | | |
| .venv/bin/python3 -m pytest src/india_api --cov -s src/india_api --cov-report=xml | |
| # Create test summary to be visualised on the job summary screen on GitHub | |
| # * Runs even if previous steps fail | |
| - name: Create test summary | |
| uses: test-summary/action@v2 | |
| with: | |
| paths: "*t-report.xml" | |
| show: "fail, skip" | |
| if: always() | |
| # Define a "build-container" job that runs on branch commits only | |
| # * Builds and pushes an OCI Container image to the registry defined in the environment variables | |
| # * Only runs if test job passes | |
| build-container: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: read | |
| packages: write | |
| needs: test-unit | |
| if: github.event_name != 'pull_request' | |
| steps: | |
| # Do a non-shallow clone of the repo to ensure tags are present | |
| # * This allows setuptools-git-versioning to automatically set the version | |
| - name: Checkout repository | |
| uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 | |
| - name: Set up Buildx | |
| uses: docker/setup-buildx-action@v2 | |
| - name: Log in to the Container registry | |
| uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1 | |
| with: | |
| registry: ${{ env.REGISTRY }} | |
| username: ${{ github.actor }} | |
| password: ${{ secrets.GITHUB_TOKEN }} | |
| # Tag the built image according to the event type | |
| # * If the event is a valid version tag, use the tag name | |
| # * If the event is a branch commit, use the commit sha | |
| - name: Extract metadata (tags, labels) for Container | |
| id: meta | |
| uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7 | |
| with: | |
| images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} | |
| tags: | | |
| type=ref,event=branch | |
| type=semver,pattern={{version}} | |
| # Build and push the Container image to the registry | |
| # * Creates a multiplatform-aware image | |
| # * Semantic versioning is handled via the meta action | |
| # * The image layers are cached between action runs | |
| - name: Build and push Container image | |
| uses: docker/build-push-action@v4 | |
| with: | |
| context: . | |
| file: Containerfile | |
| push: true | |
| tags: ${{ steps.meta.outputs.tags }} | |
| labels: ${{ steps.meta.outputs.labels }} | |
| platforms: linux/amd64,linux/arm64 | |
| cache-from: type=gha | |
| cache-to: type=gha,mode=max | |
| key: ${{ runner.os }}-venv-${{ hashFiles('**/pyproject.toml') }} | |