-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #247 from consideRatio/pr/pyproject
Transition to use pyproject.toml and tbump
- Loading branch information
Showing
9 changed files
with
171 additions
and
164 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,71 +1,60 @@ | ||
| # How to make a release | ||
|
|
||
| `chartpress` is a package [available on | ||
| PyPI](https://pypi.org/project/chartpress/). These are instructions on how to | ||
| make a release on PyPI. The PyPI release is packaged and published automatically | ||
| by a GitHub workflow when a git tag is pushed. | ||
| `chartpress` is a package available on [PyPI] and [conda-forge]. | ||
|
|
||
| For you to follow along according to these instructions, you need: | ||
| These are the instructions on how to make a release. | ||
|
|
||
| - To have push rights to the [chartpress GitHub | ||
| repository](https://github.com/jupyterhub/chartpress). | ||
| ## Pre-requisites | ||
|
|
||
| - Push rights to this GitHub repository | ||
|
|
||
| ## Steps to make a release | ||
|
|
||
| 1. Update [CHANGELOG.md](CHANGELOG.md) if it is not up to date, and verify | ||
| [README.md](README.md) has an updated output of running `--help`. Make a PR | ||
| to review the CHANGELOG notes. | ||
| 1. Create a PR updating `CHANGELOG.md` with [github-activity] and continue when | ||
| its merged. For details about this, see the [team-compass documentation] | ||
| about it. | ||
|
|
||
| To get the foundation of the changelog written, you can install | ||
| [github-activity](https://github.com/choldgraf/github-activity) and run | ||
| `github-activity jupyterhub/chartpress` after setting up | ||
| credentials as described in the project's README.md file. | ||
| [team-compass documentation]: https://jupyterhub-team-compass.readthedocs.io/en/latest/practices/releases.html | ||
|
|
||
| 1. Once the changelog is up to date, checkout main and make sure it is up to date and clean. | ||
| 2. Checkout main and make sure it is up to date. | ||
|
|
||
| ```bash | ||
| ORIGIN=${ORIGIN:-origin} # set to the canonical remote, e.g. 'upstream' if 'origin' is not the official repo | ||
| ```shell | ||
| git checkout main | ||
| git fetch $ORIGIN main | ||
| git reset --hard $ORIGIN/main | ||
| # WARNING! This next command deletes any untracked files in the repo | ||
| git clean -xfd | ||
| git fetch origin main | ||
| git reset --hard origin/main | ||
| ``` | ||
|
|
||
| 1. Update the version with `bump2version` (can be installed with `pip install -r dev-requirements.txt`) | ||
| 3. Update the version, make commits, and push a git tag with `tbump`. | ||
|
|
||
| ```bash | ||
| VERSION=... # e.g. 1.2.3 | ||
| bump2version --tag --new-version $VERSION - | ||
| ```shell | ||
| pip install tbump | ||
| ``` | ||
|
|
||
| 1. Reset the version to the next development version with `bump2version` | ||
| `tbump` will ask for confirmation before doing anything. | ||
|
|
||
| ```bash | ||
| bump2version --no-tag patch | ||
| ```shell | ||
| # Example versions to set: 1.0.0, 1.0.0b1 | ||
| VERSION= | ||
| tbump ${VERSION} | ||
| ``` | ||
|
|
||
| 1. Push your two commits to main along with the annotated tags referencing | ||
| commits on main. | ||
|
|
||
| ``` | ||
| git push --follow-tags $ORIGIN main | ||
| ``` | ||
| Following this, the [CI system] will build and publish a release. | ||
|
|
||
| ## Manually uploading to PyPI | ||
| 4. Reset the version back to dev, e.g. `1.0.1.dev` after releasing `1.0.0`. | ||
|
|
||
| We are using CI with GitHub workflows to automatically publish to PyPI, but if | ||
| you want to do it manually when you are on a tagged commit in a otherwise | ||
| cleaned repository, you can do this. | ||
|
|
||
| 1. Package the release | ||
|
|
||
| ```bash | ||
| python3 setup.py sdist bdist_wheel | ||
| ```shell | ||
| # Example version to set: 1.0.1.dev | ||
| NEXT_VERSION= | ||
| tbump --no-tag ${NEXT_VERSION}.dev | ||
| ``` | ||
|
|
||
| 1. Upload it to PyPI | ||
| 5. Following the release to PyPI, an automated PR should arrive within 24 hours | ||
| to [conda-forge/chartpress-feedstock] with instructions | ||
| on releasing to conda-forge. You are welcome to volunteer doing this, but | ||
| aren't required as part of making this release to PyPI. | ||
|
|
||
| ```bash | ||
| twine upload dist/* | ||
| ``` | ||
| [github-activity]: https://github.com/executablebooks/github-activity | ||
| [pypi]: https://pypi.org/project/chartpress/ | ||
| [conda-forge]: https://anaconda.org/conda-forge/chartpress | ||
| [conda-forge/chartpress-feedstock]: https://github.com/conda-forge/chartpress-feedstock | ||
| [ci system]: https://github.com/jupyterhub/chartpress/actions/workflows/release.yaml |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| # build-system | ||
| # - ref: https://peps.python.org/pep-0517/ | ||
| # | ||
| [build-system] | ||
| requires = ["setuptools", "setuptools-scm"] | ||
| build-backend = "setuptools.build_meta" | ||
|
|
||
|
|
||
| # project | ||
| # - ref 1: https://peps.python.org/pep-0621/ | ||
| # - ref 2: https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html | ||
| # | ||
| [project] | ||
| name = "chartpress" | ||
| version = "2.3.1.dev" | ||
| authors = [ | ||
| {name = "Jupyter Development Team", email = "[email protected]"}, | ||
| ] | ||
| description = "ChartPress: render and publish helm charts and images" | ||
| keywords = ["helm", "kubernetes"] | ||
| dynamic = ["readme"] | ||
| license = {file = "LICENSE"} | ||
| requires-python = ">=3.7" | ||
| classifiers = [ | ||
| "Intended Audience :: Developers", | ||
| "Intended Audience :: System Administrators", | ||
| "License :: OSI Approved :: BSD License", | ||
| "Operating System :: POSIX :: Linux", | ||
| "Operating System :: MacOS :: MacOS X", | ||
| "Programming Language :: Python", | ||
| "Programming Language :: Python :: 3", | ||
| ] | ||
| dependencies = [ | ||
| "ruamel.yaml>=0.15.44", | ||
| # Bug in 5.0.0: https://github.com/docker/docker-py/pull/2844 | ||
| "docker>=3.2.0,!=5.0.0", | ||
| ] | ||
|
|
||
| [project.optional-dependencies] | ||
| test = [ | ||
| "gitpython", | ||
| "pytest", | ||
| "pytest-cov", | ||
| "tbump", | ||
| ] | ||
|
|
||
| [project.urls] | ||
| Documentation = "https://github.com/jupyterhub/chartpress#readme" | ||
| Source = "https://github.com/jupyterhub/chartpress" | ||
| Issues = "https://github.com/jupyterhub/chartpress/issues" | ||
|
|
||
| [project.scripts] | ||
| chartpress = "chartpress:main" | ||
|
|
||
|
|
||
| # setuptools | ||
| # - ref: https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html#setuptools-specific-configuration | ||
| # | ||
| [tool.setuptools] | ||
| py-modules = ["chartpress"] | ||
|
|
||
| [tool.setuptools.dynamic] | ||
| readme = { file = "README.md", content-type = "text/markdown" } | ||
|
|
||
|
|
||
| # black is used for autoformatting Python code | ||
| # | ||
| # ref: https://black.readthedocs.io/en/stable/ | ||
| # | ||
| [tool.black] | ||
| skip-string-normalization = false | ||
|
|
||
|
|
||
| # isort is used for autoformatting Python code | ||
| # | ||
| # ref: https://pycqa.github.io/isort/ | ||
| # | ||
| [tool.isort] | ||
| profile = "black" | ||
|
|
||
|
|
||
| # pytest is used for running Python based tests | ||
| # | ||
| # ref: https://docs.pytest.org/en/stable/ | ||
| # | ||
| [tool.pytest.ini_options] | ||
| addopts = "--verbose --color=yes --durations=10 --cov=chartpress" | ||
| testpaths = ["tests"] | ||
|
|
||
|
|
||
| # tbump is used to simplify and standardize the release process when updating | ||
| # the version, making a git commit and tag, and pushing changes. | ||
| # | ||
| # ref: https://github.com/your-tools/tbump#readme | ||
| # | ||
| [tool.tbump] | ||
| github_url = "https://github.com/jupyterhub/chartpress" | ||
|
|
||
| [tool.tbump.version] | ||
| current = "2.3.1.dev" | ||
| regex = ''' | ||
| (?P<major>\d+) | ||
| \. | ||
| (?P<minor>\d+) | ||
| \. | ||
| (?P<patch>\d+) | ||
| (?P<pre>((a|b|rc)\d+)|) | ||
| \.? | ||
| (?P<dev>(?<=\.)dev\d*|) | ||
| ''' | ||
|
|
||
| [tool.tbump.git] | ||
| message_template = "Bump to {new_version}" | ||
| tag_template = "{new_version}" | ||
|
|
||
| [[tool.tbump.file]] | ||
| src = "chartpress.py" |
Oops, something went wrong.