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

feat(dev): add release and versioning guidelines #72

Merged
merged 1 commit into from
Feb 15, 2024
Merged

Conversation

josecm
Copy link
Member

@josecm josecm commented Oct 27, 2023

This PR introduces the release and versioning guidelines. I present it as a draft for opening discussion on two main questions:

  1. Should we have release candidates (e.g. 1.2.0-rc1) during the stabilization stage?
  2. What CI automation could we add to support this process? Examples would be:
  • Adding protections to avoid merging of PRs not related to bug fixes, documentation or testing during stabilization;
  • Automatic deployment of more complete test batteries for release candidates;
  • More ideas?

TODO:

  • Add release log and annoucement guidelines.

Copy link
Member

@danielRep danielRep left a comment

Choose a reason for hiding this comment

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

Small typos and format changes.
Overall, I agree with everything.

@danielRep
Copy link
Member

This PR introduces the release and versioning guidelines. I present it as a draft for opening discussion on two main questions:

  1. Should we have release candidates (e.g. 1.2.0-rc1) during the stabilization stage?

IMHO, this could be postponed as we feel necessary to add such concept on the versioning for testing reasons for example.

  1. What CI automation could we add to support this process? Examples would be:
  • Adding protections to avoid merging of PRs not related to bug fixes, documentation or testing during stabilization;
  • Automatic deployment of more complete test batteries for release candidates;
  • More ideas?

I agree with the first point. In the same idea, we could automatically bump the version at each bug fix, feature added, etc.

@josecm
Copy link
Member Author

josecm commented Dec 5, 2023

@danielRep I think I addressed most of the issues. Also, I've increase the column limit to 100.

This PR introduces the release and versioning guidelines. I present it as a draft for opening discussion on two main questions:

  1. Should we have release candidates (e.g. 1.2.0-rc1) during the stabilization stage?

IMHO, this could be postponed as we feel necessary to add such concept on the versioning for testing reasons for example.

Agree.

  1. What CI automation could we add to support this process? Examples would be:
  • Adding protections to avoid merging of PRs not related to bug fixes, documentation or testing during stabilization;
  • Automatic deployment of more complete test batteries for release candidates;
  • More ideas?

I agree with the first point. In the same idea, we could automatically bump the version at each bug fix, feature added, etc.

Yes. But I don't see how we'd integrate this into GitHub without tagging RCs, nor how we'd automatically identify bugs vs docs vs feature PRs. We would need a PR tag system, at least.

source/development/versioning.rst Outdated Show resolved Hide resolved
source/development/versioning.rst Outdated Show resolved Hide resolved
@danielRep
Copy link
Member

Small missing tweaks @josecm . Please rebase too.

@danielRep danielRep self-assigned this Dec 18, 2023
@josecm
Copy link
Member Author

josecm commented Dec 18, 2023

Change release cadence to be fixed every 4 moths.

@danielRep danielRep marked this pull request as ready for review January 5, 2024 14:30
source/development/versioning.rst Outdated Show resolved Hide resolved
@josecm
Copy link
Member Author

josecm commented Jan 19, 2024

@danielRep @miguelafsilva5 Along with the proposed fixes, I also introduced the section on the "Release Announcement".

Copy link
Member

@danielRep danielRep left a comment

Choose a reason for hiding this comment

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

Please solve the checker issues @josecm

danielRep
danielRep previously approved these changes Feb 15, 2024
miguelafsilva5
miguelafsilva5 previously approved these changes Feb 15, 2024
danielRep
danielRep previously approved these changes Feb 15, 2024
@danielRep danielRep dismissed stale reviews from miguelafsilva5 and themself via f012d06 February 15, 2024 14:04
@danielRep danielRep force-pushed the feat/versioning branch 2 times, most recently from f012d06 to b67c9a4 Compare February 15, 2024 14:08
@danielRep danielRep merged commit e531d8b into main Feb 15, 2024
4 checks passed
@danielRep danielRep deleted the feat/versioning branch February 15, 2024 14:18
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.

3 participants