Skip to content

Commit

Permalink
Refactor install steps into resusable action
Browse files Browse the repository at this point in the history
  • Loading branch information
pvandyken committed Dec 11, 2023
1 parent dd2ce68 commit fc7fc9a
Show file tree
Hide file tree
Showing 3 changed files with 99 additions and 141 deletions.
50 changes: 50 additions & 0 deletions .github/actions/install-project/action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: Install Project
description: Install Snakebids and its dependencies
inputs:
python-version:
required: true
description: Python version to install
reference:
required: true
description: >
Reference ID to use for defining poetry cache (e.g. pull request id
or commit SHA)
runs:
using: composite
steps:
# install & configure poetry
- name: Cache Poetry Installation
id: cached-poetry
uses: actions/cache@v3
with:
path: ~/.local
key: ${{ runner.os }}-poetry-${{ inputs.reference }}
- name: Install Poetry
uses: snok/install-poetry@v1
if: steps.cached-poetry.outputs.cache-hit != 'true'
with:
virtualenvs-create: true
virtualenvs-in-project: true

- name: Setup Python
id: setup-python
uses: actions/setup-python@v4
with:
python-version: ${{ inputs.python-version }}
cache: 'poetry'
- name: Store Pip Cache
uses: actions/cache@v3
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ steps.setup-python.outputs.python-version }}
restore-keys: ${{ runner.os }}-pip-${{ steps.setup-python.outputs.python-version }}

# install dependencies
- name: Install dependencies
shell: bash
if: steps.setup-python.outputs.cache-hit != 'true'
run: poetry install --no-interaction --no-ansi --no-root
- name: Install library
shell: bash
run: poetry install --no-interaction --no-ansi
2 changes: 1 addition & 1 deletion .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ jobs:
git fetch --tags
- name: Set up Python
uses: actions/setup-python@v2
uses: actions/setup-python@v4
with:
python-version: '3.9'

Expand Down
188 changes: 48 additions & 140 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,40 +20,11 @@ jobs:
steps:
- name: Clone repo
uses: actions/checkout@v3

# install & configure poetry
- name: Cache Poetry Installation
id: cached-poetry
uses: actions/cache@v3
with:
path: ~/.local
key: ${{ runner.os }}-poetry-${{ github.event.pull_request.id || github.event.after }}
- name: Install Poetry
uses: snok/install-poetry@v1
if: steps.cached-poetry.outputs.cache-hit != 'true'
with:
virtualenvs-create: true
virtualenvs-in-project: true

- name: Setup Python
id: setup-python
uses: actions/setup-python@v4
- name: Install
uses: ./.github/actions/install-project
with:
python-version: '3.11'
cache: 'poetry'
- name: Store Pip Cache
uses: actions/cache@v3
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ steps.setup-python.outputs.python-version }}
restore-keys: ${{ runner.os }}-pip-${{ steps.setup-python.outputs.python-version }}

# install dependencies
- name: Install dependencies
if: steps.setup-python.outputs.cache-hit != 'true'
run: poetry install --no-interaction --no-ansi --no-root
- name: Install library
run: poetry install --no-interaction --no-ansi
reference: ${{ github.event.pull_request.id || github.event.after }}

# run python style checks
- name: Poetry Lock Check
Expand All @@ -74,41 +45,12 @@ jobs:
matrix:
python-version: ['3.8', '3.9', '3.10', '3.11']
steps:
- uses: actions/checkout@v3

# install & configure poetry
- name: Cache Poetry Installation
id: cached-poetry
uses: actions/cache@v3
with:
path: ~/.local
key: ${{ runner.os }}-poetry-${{ github.event.pull_request.id || github.event.after }}
- name: Install Poetry
if: steps.cached-poetry.outputs.cache-hit != 'true'
uses: snok/install-poetry@v1
with:
virtualenvs-create: true
virtualenvs-in-project: true

- name: Set up Python ${{ matrix.python-version }}
id: setup-python
uses: actions/setup-python@v4
- name: Clone repo
uses: actions/checkout@v3
- uses: ./.github/actions/install-project
with:
python-version: ${{ matrix.python-version }}
cache: 'poetry'
- name: Store pip cache
uses: actions/cache@v3
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ steps.setup-python.outputs.python-version }}
restore-keys: |
${{ runner.os }}-pip-${{ steps.setup-python.outputs.python-version }}
${{ runner.os }}-pip-
# install dependencies if cache does not exist
- name: Install dependencies
if: steps.setup-python.outputs.cache-hit != 'true'
run: poetry install --no-interaction --no-root --no-ansi
reference: ${{ github.event.pull_request.id || github.event.after }}

# Build docker container needed for test
- name: Set up QEMU
Expand Down Expand Up @@ -146,81 +88,47 @@ jobs:
split: ['1', '2', '3', '4', '5']
fail-fast: false
steps:
- uses: actions/checkout@v3

# install & configure poetry
- name: Cache Poetry Installation
id: cached-poetry
uses: actions/cache@v3
with:
path: ~/.local
key: ${{ runner.os }}-poetry-${{ github.event.pull_request.id || github.event.after }}
- name: Install Poetry
uses: snok/install-poetry@v1
if: steps.cached-poetry.outputs.cache-hit != 'true'
with:
# Ensure this specification is removed when py37 support is dropped
version: 1.5.1
virtualenvs-create: true
virtualenvs-in-project: true

- name: Set up Python ${{ matrix.python-version }}
id: setup-python
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
cache: poetry
- uses: actions/cache@v3
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ steps.setup-python.outputs.python-version }}
restore-keys: |
${{ runner.os }}-pip-${{ steps.setup-python.outputs.python-version }}
${{ runner.os }}-pip-
# install dependencies
- name: Install dependencies
if: steps.setup-python.outputs.cache-hit != 'true'
run: poetry install --no-interaction --no-root --no-ansi


# Build docker container needed for test
- name: Set up QEMU
uses: docker/setup-qemu-action@v3
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
- name: Cache Template Testing Containers
uses: actions/cache@v3
with:
path: container-test-template-cache
key: ${{ runner.os }}-test-template-cache-${{ hashFiles('containers/test-template/**') }}-${{ steps.setup-python.outputs.python-version }}
- name: Inject container-test-template-cache into docker
uses: reproducible-containers/[email protected]
with:
cache-source: container-test-template-cache
- name: Build Docker container for cache
uses: docker/build-push-action@v5
with:
context: containers/test-template
cache-from: type=gha
cache-to: type=gha,mode=max
push: false
load: true
tags: snakebids/test-template:${{ steps.setup-python.outputs.python-version }}
platforms: linux/amd64
build-args: |
PYTHON_VERSION=${{ steps.setup-python.outputs.python-version }}
- name: Install library
run: poetry install --no-interaction --no-ansi

- name: Test with pytest
env:
HYPOTHESIS_PROFILE: pr
run: >-
poetry run pytest -n auto --splits 5 --group ${{ matrix.split }}
--doctest-modules --ignore=docs
--ignore=snakebids/project_template --benchmark-disable
- name: Clone repo
uses: actions/checkout@v3
- name: install
uses: ./.github/actions/install-project
with:
python-version: ${{ matrix.python-version }}
reference: ${{ github.event.pull_request.id || github.event.after }}
# Build docker container needed for test
- name: Set up QEMU
uses: docker/setup-qemu-action@v3
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
- name: Cache Template Testing Containers
uses: actions/cache@v3
with:
path: container-test-template-cache
key: ${{ runner.os }}-test-template-cache-${{ hashFiles('containers/test-template/**') }}-${{ steps.setup-python.outputs.python-version }}
- name: Inject container-test-template-cache into docker
uses: reproducible-containers/[email protected]
with:
cache-source: container-test-template-cache
- name: Build Docker container for cache
uses: docker/build-push-action@v5
with:
context: containers/test-template
cache-from: type=gha
cache-to: type=gha,mode=max
push: false
load: true
tags: snakebids/test-template:${{ steps.setup-python.outputs.python-version }}
platforms: linux/amd64
build-args: |
PYTHON_VERSION=${{ steps.setup-python.outputs.python-version }}
- name: Test with pytest
env:
HYPOTHESIS_PROFILE: pr
run: >-
poetry run pytest -n auto --splits 5 --group ${{ matrix.split }}
--doctest-modules --ignore=docs
--ignore=snakebids/project_template --benchmark-disable
deployment_on_base:
runs-on: ubuntu-latest
Expand Down

0 comments on commit fc7fc9a

Please sign in to comment.