diff options
| author | Jordan Cook <jordan.cook@pioneer.com> | 2021-04-17 12:03:01 -0500 |
|---|---|---|
| committer | Jordan Cook <jordan.cook@pioneer.com> | 2021-04-17 12:09:52 -0500 |
| commit | ff5a9c3b64a0c34daedda3b00ed58520ce5abced (patch) | |
| tree | a323fbf1405ad632b7c55e143a02575a026b935b /CONTRIBUTING.md | |
| parent | dae614ea8e8e79ab486ba141d13cd5080fd76a13 (diff) | |
| download | requests-cache-ff5a9c3b64a0c34daedda3b00ed58520ce5abced.tar.gz | |
Set up automatic pre-release builds from dev branch
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0f68c92..3b734f9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -145,3 +145,12 @@ Release steps: - Push a new tag, e.g.: `git tag v0.1 && git push origin --tags` - This will trigger a deployment. Verify that this completes successfully and that the new version can be installed from pypi with `pip install` + +## Pre-Releases +Pre-release builds are convenient for letting testers try out in-development changes. Versions with +the suffix `.dev` (among others) can be deployed to PyPI and installed by users with `pip install --pre`, +and are otherwise ignored by `pip install`. See python packaging docs on +[pre-release versioning](https://packaging.python.org/guides/distributing-packages-using-setuptools/#pre-release-versioning) +for more details. + +A pre-release build for requests-cache will automatically be published for **any commits to the dev branch.** |