finish migrating release process to github actions
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 777
- Forks
- 31
- PR merge metrics
- No merged PRs in 30d
Description
Currently there are some manual steps:
- Update the version in
pyproject.toml - Update the version in
pugsql/__init__.py - Push the code.
- Run
bin/release
bin/release does the following:
- Runs some checks (to make sure that the versions updated above agree, and that the tests pass).
- Tags the release and pushes.
- Builds the documentation (using
pdoc) - Attempts to wait for pypi to have the new version, before updating the docs site so that it reflects the most recent version.
- Pushes the docs site.
This was put in place years ago before actions existed. A lot of that is redundant or convoluted. We can probably simplify a lot of this.
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Start by reading bin/release and the version declarations in pyproject.toml and pugsql/init.py, including how pdoc builds the documentation. Done means the release checks, tagging, package release, and documentation publishing run through GitHub Actions without the listed manual steps.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, python
- Domain
- ci-cd, documentation, release
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100