precice / precice/python-bindings

Test package uploading to PyPI before releasing and creating a new version tag

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

Nobody has claimed this yet.

good first issue
Dominant language
Cython
Stars
30
Forks
19
PR merge metrics
No merged PRs in 30d

Description

Currently, we run the release workflow to upload the package to PyPI after creating a tag on GitHub, which is typically associated with a newly released version. If the release workflow fails, it is too late to make corrections since the release is complete and the tag has been created. Testing whether the release workflow works before actually releasing a new version would be helpful.

The PyPI Publish GitHub Action usage states that packages can be pushed to the instance TestPyPI. An additional workflow can be added which uploads the package to TestPyPI, to test the release workflow, and also the creation of distribution archives before releasing a new version

Contributor guide

No contributing guide indexed for this repository

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

Start by reading .github/workflows/release.yml and the PyPI Publish GitHub Action usage for TestPyPI. Add a workflow that uploads the package and its distribution archives to TestPyPI before a real release. Done means the workflow can validate packaging and publishing without creating a new version tag or releasing to PyPI.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.