Switch to a branch-based release model #382
Merged
Conversation
This file contains 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
btjanaka
added a commit
that referenced
this pull request
Sep 22, 2023
## Description <!-- Provide a brief description of the PR's purpose here. --> Following the new instructions in #382, the actual 0.6.2 release will happen on the `release/0.6.x` branch. ## TODO <!-- Notable points that this PR has either accomplished or will accomplish. --> - [x] Bump version - [x] Update history ## Questions <!-- Any concerns or points of confusion? --> ## Status - [x] I have read the guidelines in [CONTRIBUTING.md](https://github.com/icaros-usc/pyribs/blob/master/CONTRIBUTING.md) - [x] I have formatted my code using `yapf` - [x] I have tested my code by running `pytest` - [x] I have linted my code with `pylint` - [x] I have added a one-line description of my change to the changelog in `HISTORY.md` - [x] This PR is ready to go
btjanaka
added a commit
that referenced
this pull request
Sep 22, 2023
## Description <!-- Provide a brief description of the PR's purpose here. --> Pyribs roughly follows a trunk-based development model. Previously, for releases, we only released from the trunk (master branch). However, this does not work well if we need to perform a patch release while trunk already has several features implemented for the next release. This PR shifts to the [branch-based release model](https://trunkbaseddevelopment.com/branch-for-release/) where we create release branches for minor versions. If we need to release patches, we can cherry pick commits from trunk into the release branch and then push the patch release. We will use this to properly release 0.6.2, as 0.6.1 was released with features for 0.7.0 (namely, OMG-MEGA and OG-MAP-Elites). ## TODO <!-- Notable points that this PR has either accomplished or will accomplish. --> - [x] Update instructions in CONTRIBUTING.md - [x] Update HISTORY.md ## Questions <!-- Any concerns or points of confusion? --> ## Status - [x] I have read the guidelines in [CONTRIBUTING.md](https://github.com/icaros-usc/pyribs/blob/master/CONTRIBUTING.md) - [x] I have formatted my code using `yapf` - [x] I have tested my code by running `pytest` - [x] I have linted my code with `pylint` - [x] I have added a one-line description of my change to the changelog in `HISTORY.md` - [x] This PR is ready to go
btjanaka
added a commit
that referenced
this pull request
Sep 22, 2023
## Description <!-- Provide a brief description of the PR's purpose here. --> Following the new instructions in #382, the actual 0.6.2 release will happen on the `release/0.6.x` branch. ## TODO <!-- Notable points that this PR has either accomplished or will accomplish. --> - [x] Bump version - [x] Update history ## Questions <!-- Any concerns or points of confusion? --> ## Status - [x] I have read the guidelines in [CONTRIBUTING.md](https://github.com/icaros-usc/pyribs/blob/master/CONTRIBUTING.md) - [x] I have formatted my code using `yapf` - [x] I have tested my code by running `pytest` - [x] I have linted my code with `pylint` - [x] I have added a one-line description of my change to the changelog in `HISTORY.md` - [x] This PR is ready to go
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.
Description
Pyribs roughly follows a trunk-based development model. Previously, for releases, we only released from the trunk (master branch). However, this does not work well if we need to perform a patch release while trunk already has several features implemented for the next release. This PR shifts to the branch-based release model where we create release branches for minor versions. If we need to release patches, we can cherry pick commits from trunk into the release branch and then push the patch release. We will use this to properly release 0.6.2, as 0.6.1 was released with features for 0.7.0 (namely, OMG-MEGA and OG-MAP-Elites).
TODO
Questions
Status
CONTRIBUTING.md
yapfpytestpylintHISTORY.md