Add example using GHA cache backend #39
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
| # Copyright 2022 Pants project contributors. | |
| # Licensed under the Apache License, Version 2.0 (see LICENSE). | |
| # See https://pants.readme.io/docs/using-pants-in-ci for tips on how to set up your CI with Pants. | |
| name: Pants | |
| on: [push, pull_request] | |
| jobs: | |
| org-check: | |
| name: Check GitHub Organization | |
| if: ${{ github.repository_owner == 'pantsbuild' }} | |
| runs-on: ubuntu-20.04 | |
| steps: | |
| - name: Noop | |
| run: "true" | |
| build: | |
| name: Perform CI Checks | |
| needs: org-check | |
| runs-on: ubuntu-20.04 | |
| strategy: | |
| matrix: | |
| python-version: [3.8] | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - uses: crazy-max/ghaction-setup-docker@v3 | |
| with: | |
| daemon-config: | | |
| { | |
| "features": { | |
| "containerd-snapshotter": true | |
| } | |
| } | |
| - uses: docker/setup-buildx-action@v3 | |
| with: | |
| install: true | |
| driver: docker | |
| # Required for multi-platform builds | |
| - name: Setup QEMU | |
| uses: docker/setup-qemu-action@v3 | |
| with: | |
| platforms: linux/amd64,linux/arm64 | |
| # Exposes Github env vars needed for docker caching - see https://github.com/orgs/community/discussions/42856 | |
| - name: Expose GitHub Runtime | |
| uses: crazy-max/ghaction-github-runtime@v3 | |
| - uses: pantsbuild/actions/init-pants@v5-scie-pants | |
| # This action bootstraps pants and manages 2-3 GHA caches. | |
| # See: github.com/pantsbuild/actions/tree/main/init-pants/ | |
| with: | |
| # v0 makes it easy to bust the cache if needed | |
| # just increase the integer to start with a fresh cache | |
| gha-cache-key: v0 | |
| # This repo has no 3rd-party requirements and no lockfiles, so we don't invalidate | |
| # the named caches on anything extra. See other example repos for better examples of | |
| # how to set up this cache. | |
| named-caches-hash: "" | |
| # If you're not using a fine-grained remote caching service (see https://www.pantsbuild.org/docs/remote-caching), | |
| # then you may also want to preserve the local Pants cache (lmdb_store). However this must invalidate for | |
| # changes to any file that can affect the build, so may not be practical in larger repos. | |
| # A remote cache service integrates with Pants's fine-grained invalidation and avoids these problems. | |
| cache-lmdb-store: 'true' # defaults to 'false' | |
| # Note that named_caches and lmdb_store falls back to partial restore keys which | |
| # may give a useful partial result that will save time over completely clean state, | |
| # but will cause the cache entry to grow without bound over time. | |
| # See https://pants.readme.io/docs/using-pants-in-ci for tips on how to periodically clean it up. | |
| # Alternatively you change gha-cache-key to ignore old caches. | |
| - name: Bootstrap Pants | |
| run: pants --version | |
| - name: Check Pants config files | |
| run: pants tailor --check update-build-files --check '::' | |
| - name: Lint, compile, and test | |
| run: pants lint check test '::' | |
| - name: Package / Run | |
| env: | |
| DYNAMIC_TAG: workflow | |
| run: | | |
| pants --docker-build-verbose package :: | |
| - name: Upload Pants log | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: pants-log | |
| path: .pants.d/pants.log | |
| if: always() # We want the log even on failures. |