Skip to content

Conversation

JamesMGreene
Copy link
Contributor

Improve a few contribution notes in the README related to release management πŸ€·πŸ»β€β™‚οΈ

@JamesMGreene JamesMGreene requested a review from a team as a code owner August 5, 2022 20:29
README.md Outdated

2. Push a matching tag, for instance for `v0.1.0`:
2. Push a matching tag (e.g.`v0.1.0`) **if** different than the `main` branch (if not, publishing the draft release will create it):
Copy link
Contributor

Choose a reason for hiding this comment

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

Really? That's cool, do we even need this whole step then?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No, not really. I didn't do it at all for the latest release.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We can consider removing it in the future, but there is probably a bit more clarification to add regarding making sure the branch name is correct in the Release UI and such. πŸ€”

Copy link
Contributor

Choose a reason for hiding this comment

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

I published without yesterday. Let's remove the step. Publishing a release does it for us.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Revised. πŸ‘πŸ»

@JamesMGreene JamesMGreene merged commit c61e34f into main Aug 10, 2022
@JamesMGreene JamesMGreene deleted the better-docs branch August 10, 2022 19:19
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