Skip to content

Commit d2956ff

Browse files
committed
docs: how to cut a beta release
1 parent 0110c2c commit d2956ff

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

CONTRIBUTING.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,10 +101,34 @@ to validate your changes locally before going through CI.
101101
- `REPLICATE_API_BASE_URL`: Defaults to `https://api.replicate.com` but can be overriden to point the client at a development host.
102102
- `REPLICATE_API_TOKEN`: Required. Find your token at https://replicate.com/#token
103103

104-
## Publishing a release
104+
## Publishing releases
105105

106106
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.
107107

108+
### Publishing a beta release
109+
110+
Betas live in branches off the main branch.
111+
112+
First, set the version number in [pyproject.toml](pyproject.toml) and commit it to the `beta` branch.
113+
114+
```
115+
version = "1.1.0b3"
116+
```
117+
118+
Then run the following in your local checkout:
119+
120+
```sh
121+
git checkout beta
122+
git fetch --all --tags
123+
git tag 1.1.0b3
124+
git push --tags
125+
```
126+
127+
Then visit [github.com/replicate/replicate-python/actions](https://github.com/replicate/replicate-python/actions) to monitor the release process.
128+
129+
130+
### Publishing a stable release
131+
108132
First, set the version number in [pyproject.toml](pyproject.toml) and commit it to the `main` branch:
109133

110134
```

0 commit comments

Comments
 (0)