matrix-org / matrix-org/setup-python-poetry

Make use of `restore-keys`

Open
#5 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
No language data
Stars
1
Forks
5
Avg merge
2d 22h
Merged PRs (30d)
1

Description

If we don't have a cache-hit for the poetry-managed venv, we'll end up recreating it from scratch. We could save a little bit of time by restoring from a different cache with a similar name.

We could probably make use of `restore-keys` here:

https://github.com/matrix-org/setup-python-poetry/blob/71e0c442d1dff598316bd217a8c7afe86a83958f/action.yml#L65-L70

Probably `restore-keys: poetry-venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}`?

Would need to test it by making a small change to the lockfile and seeing if we modify a cached venv rather than recreating it from scratch. Or we could just make the change and YOLO it.

Either way, it's one for the wishlist.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open action.yml at lines 65–70 and review the existing cache configuration. Add the proposed restore-keys behavior, then test it by making a small lockfile change and checking whether the cached virtual environment is reused instead of recreated from scratch.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, python
Domain
ci-cd
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.