Skip to content

docs: simplify production release instructions to use github ui#110

Open
yiyche wants to merge 1 commit into
datacommonsorg:mainfrom
yiyche:update-release-docs
Open

docs: simplify production release instructions to use github ui#110
yiyche wants to merge 1 commit into
datacommonsorg:mainfrom
yiyche:update-release-docs

Conversation

@yiyche
Copy link
Copy Markdown
Member

@yiyche yiyche commented Jun 6, 2026

Simplify production release section to combine git tagging and release creation into a single GitHub UI action.

@yiyche yiyche requested a review from dwnoble June 6, 2026 02:19
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread docs/release.md
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**.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.

Suggested change
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant