Conversation
Point to GitHub Releases instead and updates PR template with instructions
pkerpedjiev
reviewed
Jan 28, 2025
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]`. |
Member
There was a problem hiding this comment.
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.
Member
Author
There was a problem hiding this comment.
Since all the steps that follow are a part of "drafting a release", I reorganized things. Let me know hwat you think.
a790276 to
13c21e5
Compare
pkerpedjiev
approved these changes
Jan 29, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents the full release flow via the GitHub UI.
Also removes
CHANGELOG.mdto avoid redundancy. Points to GitHub Releases instead and updates PR template withinstructions.