docs: simplify production release instructions to use github ui#110
docs: simplify production release instructions to use github ui#110yiyche wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
Code Review
This pull request updates the production release documentation in docs/release.md to guide users through publishing a release via the GitHub UI instead of manually pushing git tags. The feedback suggests improving the step-by-step instructions by recommending that the release title match the version tag and utilizing GitHub's 'Generate release notes' feature to automatically populate the description.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| Publish a new release on GitHub to automatically tag the repository and publish to PyPI: | ||
| 1. Go to [GitHub Releases](https://github.com/datacommonsorg/datacommons/releases) and click **Draft a new release**. | ||
| 2. Click **Choose a tag**, type your new version tag (e.g., `v1.2.3`), and select **Create new tag on publish**. | ||
| 3. Set target to `main`, add a title/description, and click **Publish release**. |
There was a problem hiding this comment.
To make the release process more efficient and consistent, it is recommended to specify that the release title should match the version tag, and to suggest using GitHub's Generate release notes button to automatically populate the release description.
| 3. Set target to `main`, add a title/description, and click **Publish release**. | |
| 3. Set target to "main", set the Release title to your version tag (e.g., "v1.2.3"), click Generate release notes to automatically populate the description, and click Publish release. |
Simplify production release section to combine git tagging and release creation into a single GitHub UI action.