Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document release flow in README.md #164

Merged
merged 4 commits into from
Jan 29, 2025
Merged

Document release flow in README.md #164

merged 4 commits into from
Jan 29, 2025

Conversation

manzt
Copy link
Member

@manzt manzt commented Jan 27, 2025

Documents the full release flow via the GitHub UI.

Releases are managed via the GitHub UI:

  1. Draft a new release
  2. Create a tag in the format v[major].[minor].[patch].
    • Note: You can either create the tag in the GitHub UI or select an existing tag created via the Git CLI. The tag triggers publishing to PyPI.
  3. Generate release notes to summarize changes from merged PRs, and edit.
    • Documentation and CI changes don't belong in release notes
  4. Add details for significant changes or migration steps, and ensure titles are clear and consistent.

Also removes CHANGELOG.md to avoid redundancy. Points to GitHub Releases instead and updates PR template with
instructions.

manzt added 3 commits January 28, 2025 13:56
Point to GitHub Releases instead and updates PR template with
instructions
README.md Outdated
Releases are managed via the GitHub UI:

1. [Draft a new release](https://github.com/higlass/higlass-python/releases/new)
2. **Create a tag** in the format `v[major].[minor].[patch]`.
Copy link
Member

Choose a reason for hiding this comment

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

As per the Slack conversation, I recommend making 2. a sub item of 1 so that it's clear that the tag is created during the release process.

Copy link
Member Author

Choose a reason for hiding this comment

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

Since all the steps that follow are a part of "drafting a release", I reorganized things. Let me know hwat you think.

Copy link
Member

Choose a reason for hiding this comment

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

Looks good 👍

@manzt manzt force-pushed the manzt/release branch 2 times, most recently from a790276 to 13c21e5 Compare January 29, 2025 00:10
@manzt manzt merged commit b96c1c4 into main Jan 29, 2025
6 checks passed
@manzt manzt deleted the manzt/release branch January 29, 2025 01:16
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.

2 participants