Skip to content

Commit

Permalink
Add github action workflow for testing/linting
Browse files Browse the repository at this point in the history
  • Loading branch information
echeng06 committed Nov 13, 2024
1 parent 65def42 commit 27d0e41
Showing 1 changed file with 56 additions and 0 deletions.
56 changes: 56 additions & 0 deletions .github/workflows/pants.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Based on
# https://github.com/pantsbuild/example-python/blob/main/.github/workflows/pants.yaml

name: Pants

on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]

permissions:
contents: read

jobs:
build:
name: Perform CI checks
runs-on: ubuntu-latest
strategy:
matri:
python-version: [3.11]
steps:
- name: Set up Pants with Python 3.11
- uses: actions/checkout@v4
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- uses: pantsbuild/actions/init-pants@v8
# 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
# The Python backend uses named_caches for Pip/PEX state,
# so it is appropriate to invalidate on lockfile changes.
named-caches-hash: ${{ hashFiles('python-default.lock') }}
# 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://www.pantsbuild.org/2.21/docs/using-pants/using-pants-in-ci for tips on how to periodically clean it up.
# Alternatively you change gha-cache-key to ignore old caches.
- name: Check BUILD files
run: |
pants tailor --check update-build-files --check ::
- name: Lint
run: |
pants lint ::
- name: Test
run: |
pants test ::

0 comments on commit 27d0e41

Please sign in to comment.