Skip to content

Commit be241f4

Browse files
committed
Editing pass having just done a release
1 parent 2f87e82 commit be241f4

1 file changed

Lines changed: 38 additions & 8 deletions

File tree

‎docs/dev-guide.md‎

Lines changed: 38 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -243,10 +243,12 @@ uvx linkchecker --check-extern --no-warnings http://localhost:4000/server-client
243243
To do a release and publish a new version to [PyPI](https://pypi.org/project/tableauserverclient/),
244244
follow these steps:
245245

246-
1. Do a `development` to `master` branch merge. This should be a regular merge
247-
(not a squash) to ensure all individual commits are visible.
246+
1. Do a `development` to `master` branch merge. This should be a Merge commit
247+
(not Squash or Rebase) to ensure all individual commits are visible in both
248+
branches.
248249

249250
1. (Optional) Do a test publish to PyPI without creating the next version tag.
251+
Run the [Publish][] job and choosing the `development` branch.
250252
This will create a pre-release package with a version like `0.30.post0.dev`.
251253

252254
1. On a local clone of the repo, create and push the tag for the *next* version
@@ -262,12 +264,40 @@ follow these steps:
262264
git push origin tag v0.31
263265
```
264266

265-
1. Publish the updated release to PyPI by running the [Publish](https://github.com/tableau/server-client-python/actions/workflows/publish-pypi.yml)
266-
job and choosing the `master` branch.
267+
1. Create a release in GitHub with the title like "v0.31" and release notes
268+
with changes from the last release. You can try the automatic generation
269+
of notes, or create a list with your favorite AI agent (see below).
270+
271+
1. Creating the release from the new tag should automatically start the publish
272+
to PyPI. View the [Publish][] job to confirm the new version is running. If
273+
you need or want to trigger one manually, choose the `master` branch.
267274

268-
1. The job should just take a few minutes to complete, then check the updated
275+
1. Ask another maintainer to approve the publish to PyPI step from the Publish
276+
flow.
277+
278+
1. After the final publishing step, check the updated
269279
package exists on [PyPI](https://pypi.org/project/tableauserverclient/).
270280

271-
1. Create a release in GitHub with the title like "v0.31" and release notes
272-
with changes from the last release. You can try the automatic generation
273-
of notes, or just create a list of merged PR titles with reference PR numbers.
281+
[Publish]: https://github.com/tableau/server-client-python/actions/workflows/publish-pypi.yml
282+
283+
### AI prompt for release notes
284+
285+
```
286+
Generate draft release notes for this project. Use the template below. Replace "vNEW" with the new tag and "vOLD" with the prior one. For example we might have vNEW=v0.42 and vOLD=v0.41.
287+
288+
Review all the merged pull requests from vOLD to current. Make a determination between new features and bug improvements. We can also create a category called Other for anything that doesn't fit the first two buckets. For each line item, give a bold summary, a link to the pull request, and then a short explanation.
289+
290+
Markdown template follows:
291+
292+
## vNEW Release Summary
293+
294+
## New Features
295+
296+
- **SVG format support for view images** (PR #1772) — sheet images can now be downloaded as SVG in addition to PNG
297+
298+
## Bug Fixes
299+
300+
- **Treat 409 errors as success on already-created jobs** (PR #1772) — recognize when the job the user wants to create already exists
301+
302+
**Full Changelog**: https://github.com/tableau/server-client-python/compare/vOLD...vNEW
303+
```

0 commit comments

Comments
 (0)