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

Release version 4.1.0 #437

Merged
merged 3 commits into from
Dec 2, 2022
Merged

Release version 4.1.0 #437

merged 3 commits into from
Dec 2, 2022

Conversation

bemoody
Copy link
Collaborator

@bemoody bemoody commented Dec 2, 2022

Version number and documentation updates for 4.1.0.

I've added the file changes.rst. I think it is important to keep track of, and document, user-visible changes, and I think this document should be kept up to date as new changes are committed, not just when assembling a final release.

So my first thought was to ask people to update this file every time they make a pull request. But that would create merge conflicts (& even if the person merging the pull can resolve those conflicts, github can't do so itself and therefore this would break workflow checks.) And I don't want to start encouraging people to merge or cherry-pick changes from the main branch into their feature branch (rebasing would be fine, but for some reason a lot of people seem to be allergic to rebasing.) So... I don't have a good solution here, and would welcome suggestions. :)

Copy link
Member

@tompollard tompollard left a comment

Choose a reason for hiding this comment

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

Thanks @bemoody looks good to me.

So my first thought was to ask people to update this file every time they make a pull request. But that would create merge conflicts (& even if the person merging the pull can resolve those conflicts, github can't do so itself and therefore this would break workflow checks.)

I can't think of a clever way of managing this, other than trying to remind people to update the changelog immediately before merging. One thing that might help is adding some kind of reminder to a pull request template?

https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository

@bemoody bemoody merged commit 3a0d339 into main Dec 2, 2022
@bemoody bemoody deleted the release-4.1.0 branch December 2, 2022 20:05
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