Skip to content

Commit 10fe863

Browse files
committed
update
1 parent 4bec6bc commit 10fe863

File tree

1 file changed

+18
-60
lines changed

1 file changed

+18
-60
lines changed

tools/RELEASE.md

Lines changed: 18 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,13 @@ reviewed by team mates, perform one or more CANDIDATE ITERATION, and then do a
166166
final RELEASE ITERATION.
167167

168168

169-
### 5.1. Create a tag
169+
### 5.1. Push the RC branch
170+
171+
Push your branch:
172+
$ git push origin v0.11.4rc
173+
174+
175+
### 5.2. Create a tag
170176

171177
Packaging is fragile and is only triggered when a tag is pushed. To avoid
172178
finding out about packaging problems on the RC tag, it is strongly recommended
@@ -179,49 +185,17 @@ be removed after the build passes.
179185
That is to say that while the librdkafka RC is named `v0.11.4-RC3`
180186
a Python client RC with the same version is named `v0.11.4rc3`.
181187

182-
**TEST ITERATION**:
183-
184-
# Repeat with new tags until all build issues are solved.
185-
$ git tag v0.11.4rc1-dev2
186-
187-
# Delete any previous test tag you've created.
188-
$ git tag tag -d v0.11.4rc1-dev1
189-
190-
191-
**CANDIDATE ITERATION**:
192-
193-
$ git tag v0.11.4rc1
194-
195-
196-
**RELEASE ITERATION**:
197-
198-
$ git tag v0.11.4
199-
200-
201-
202-
### 5.2. Push tag and commits
203-
204-
Perform a dry-run push first to make sure the correct branch and only our tag
205-
is pushed.
206-
207-
$ git push --dry-run --tags origin v0.11.4rc # tags and branch
208-
209-
An alternative is to push branch and tags separately:
210-
211-
$ git push --dry-run origin v0.11.4rc # the branch
212-
$ git push --dry-run origin v0.11.4rc1 # the tag
213-
214-
215-
Verify that the output corresponds to what you actually wanted to push;
216-
the correct branch and tag, etc.
217-
218-
Remove `--dry-run` when you're happy with the results.
188+
Use the [Semaphore CI tag-release task](https://semaphore.ci.confluent.io/projects/clients-releases/schedulers/30e1eb9a-91de-43a4-a8de-be4f3de5a3b6) to create tags. Set the parameter accordingly:
189+
- **PROJECT**: confluent-kafka-python
190+
- **GIT_REF**: name of your RC branch (`v0.11.4rc` in this tutorial)
191+
- **TAG_NAME**: name of the new tag (`v0.11.4rc1-dev1`, for example)
192+
- You can do a test run (set **dry_run** to true) to verify the output before proceeding with the actual tag creation (set **dry_run** to true).
219193

220194

221195
### 5.3. Wait for CI builds to complete
222196

223197
Monitor Semaphore CI builds by looking at the *tag* build at
224-
[Semaphore CI](https://confluentinc.semaphoreci.com/projects/confluent-kafka-python)
198+
[Semaphore CI](https://semaphore.ci.confluent.io/projects/confluent-kafka-python)
225199

226200
CI jobs are flaky and may fail temporarily. If you see a temporary build error,
227201
e.g., a timeout, restart the specific job.
@@ -232,11 +206,11 @@ and push a new test tag. Don't forget to delete your previous test tag.
232206

233207
### 5.4. Download build artifacts
234208

235-
When all CI builds are successful it is time to download the resulting
236-
artifacts from build's Artifact directory located in another tab in the build:
209+
When all CI builds are successful it is time to download all the resulting
210+
artifacts (wheels) from build's `artifacts` directory (located in the `Artifacts` tab in the build).
211+
212+
Create a new folder `tools\dl-<tag>` under the repository root, and unzip all artifacts from the downloaded .tgz files there. You should have many artifacts (with .whl suffix) under `tools\dl-<tag>` as we support different operating systems and Python versions.
237213

238-
**Note:** The artifacts should be extracted in the folder `tools\dl-<tag>` for
239-
subsequent steps to work properly.
240214

241215
### 5.5. Verify packages
242216

@@ -253,7 +227,6 @@ the git history to look tidy, remove any test tags, and then go back to
253227
5.1 and perform the CANDIDATE ITERATION.
254228

255229

256-
257230
### 5.5.2. Create PR
258231

259232
**CANDIDATE ITERATION:**
@@ -365,27 +338,12 @@ Use Preview to check that links work as expected.
365338

366339
Create the release.
367340

368-
### 6.1. Announcement
369-
370-
Write a tweet to announce the new release, something like:
371-
372-
#Apache #Kafka #Python client confluent-kafka-python v0.11.4 released!
373-
Adds support for <mainline feature> or something about maintenance release.
374-
<link-to-release-notes-on-github>
375-
376-
377341
### 6.2. Update docs.confluent.io API docs
378342

379343
Create a PR to update the confluent-kafka-python version tag for the
380344
Python API docs on docs.confluent.io.
381345

382-
# Update the Python API docs to the latest version: includes
383-
https://github.com/confluentinc/docs and
384-
https://github.com/confluentinc/docs-platform.
385-
386-
# Update docs.confluent.io: cut the docs release branch of
387-
https://github.com/confluentinc/docs-clients-confluent-kafka-python,
388-
refers to https://confluentinc.atlassian.net/wiki/spaces/TOOLS/pages/2044330444/Create+a+new+version+of+a+documentation+repo#Create-new-release-branches.
346+
# Update the Python API docs to the latest version: https://github.com/confluentinc/docs-platform.
389347

390348

391349
### 6.3. Done!

0 commit comments

Comments
 (0)