Rehearse CLI releases on TestPyPI
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 52/100
Research direction
Start by reading .github/workflows/release.yml and diffing it against the same file at commit 5d81e1b, which already contains the job to restore. The edit is a workflow_dispatch trigger plus a job gated on main, ordered after build and verify, publishing to https://test.pypi.org/legacy/ with skip-existing: true; then add the optional rehearsal step to the "Releasing" section of CONTRIBUTING.md. Note that the testpypi environment and the pending publisher on test.pypi.org are repository and account settings only a maintainer can create, so a first-timer needs those in place before the done-when checks (manual run, rendered project page, pip install --index-url https://test.pypi.org/simple/ cobalto) can pass.
Written by the indexing model from the issue text.
Description
After the first release, add a manual rehearsal of the CLI release on TestPyPI, so later releases can be checked end to end before their tag is pushed.
Why
Before it publishes, release.yml checks everything it can: the tag against the version, the date in the changelog, twine check --strict, and a clean install of the wheel and the sdist with the example regression. Three things are only tested when a tag is pushed: the Trusted Publishing exchange with the index, the project page as the index renders it, and pip install from an index. A run against TestPyPI covers all three without using up a version number on PyPI.
It was left out of the first release (#16), which publishes to PyPI only.
What it takes
- A pending publisher on test.pypi.org (an account separate from pypi.org) for project
cobalto: ownerabstracta, repositorycobalto, workflowrelease.yml, environmenttestpypi. - A
testpypienvironment in this repository, limited tomain. - In
release.yml, aworkflow_dispatchtrigger and a job that runs only when it is started by hand onmain, after the build and verify jobs, and publishes tohttps://test.pypi.org/legacy/withskip-existing: true. The first commit of #16 had such a job:release.ymlat 5d81e1b. - The rehearsal as an optional step in the "Releasing" section of
CONTRIBUTING.md.
TestPyPI also refuses a version it already has. A rehearsal of a version that is already there is skipped, so it is worth running once the version has been raised and before the tag.
Done when
- Starting the workflow by hand on
mainpublishes the package to TestPyPI. - The project page on TestPyPI shows the README with the logo and the demo GIF.
pip install --index-url https://test.pypi.org/simple/ cobaltoinstalls it, andcobalto --versionprints that version.CONTRIBUTING.mddescribes the rehearsal.
- Dominant language
- Python
- Stars
- 2
- Forks
- 0
- Avg merge
- 4h 51m
- Merged PRs (30d)
- 9
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from abstracta/cobalto
-
extension help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day
-
compiler help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day
-
bug
Difficulty 3/5 Half a day Newbie friendliness 62/100
Maintainers usually reply within 1 day
-
help wanted
Difficulty 4/5 3-5 days Newbie friendliness 50/100
Maintainers usually reply within 1 day
All issues in abstracta/cobalto
Similar issues
-
hive size:simple
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
jxxghp/MoviePilot#7531 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
marimo-team/marimo#12027 ·
Maintainers usually reply within 1 day
-
A new VOLTTRON_HOME starts with agent isolation mode on (string comparison of a boolean default)Open
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
painted-porch/marcus#977 ·
Maintainers usually reply within 1 day