From 3036d71f1b360e16c3e4f57dcd35e49b811f541e Mon Sep 17 00:00:00 2001 From: Zeke Sikelianos Date: Tue, 26 Aug 2025 09:57:04 -0700 Subject: [PATCH] docs: how to cut a beta release --- CONTRIBUTING.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3be0146..45fea31 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -101,10 +101,34 @@ to validate your changes locally before going through CI. - `REPLICATE_API_BASE_URL`: Defaults to `https://api.replicate.com` but can be overriden to point the client at a development host. - `REPLICATE_API_TOKEN`: Required. Find your token at https://replicate.com/#token -## Publishing a release +## Publishing releases This project has a [GitHub Actions workflow](/.github/workflows/ci.yaml) that publishes the `replicate` package to PyPI. The release process is triggered by manually creating and pushing a new git tag. +### Publishing a beta release + +Betas live in branches off the main branch. + +First, set the version number in [pyproject.toml](pyproject.toml) and commit it to the `beta` branch. + +``` +version = "1.1.0b3" +``` + +Then run the following in your local checkout: + +```sh +git checkout beta +git fetch --all --tags +git tag 1.1.0b3 +git push --tags +``` + +Then visit [github.com/replicate/replicate-python/actions](https://github.com/replicate/replicate-python/actions) to monitor the release process. + + +### Publishing a stable release + First, set the version number in [pyproject.toml](pyproject.toml) and commit it to the `main` branch: ```