Update release process and add development branch info for contributing #714
Conversation
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
jreiberkyle
commented
Oct 14, 2022
Comment on lines
+7
to
+21
| #### Release Naming Conventions | ||
|
|
||
| The following are the release naming conventions: | ||
|
|
||
| 1. Current dev version: Bumped version of last release with `dev` added to the end | ||
| * **PROPOSAL**: Version number is determined by [Semantic Versioning](https://semver.org/spec/v2.0.0.html) | ||
| 1. Release version: Remove `dev` from current dev version | ||
|
|
||
| Example: | ||
| * If | ||
| * Previous Release Version == `1.0.0` | ||
| * Then | ||
| * Current Dev Version: `1.0.1dev` | ||
| * Release Version: `1.0.1` | ||
| * Next Dev Version: `1.0.2dev` |
Contributor
Author
There was a problem hiding this comment.
this is a new section
jreiberkyle
commented
Oct 14, 2022
|
|
||
| #### Step 1: Release on Github | ||
| *NOTE: This section refers to version names given in Release Naming Conventions section above.* | ||
| 1. Create a release branch named `release-{Release Version}` |
jreiberkyle
commented
Oct 14, 2022
Comment on lines
+41
to
+42
| 1. Update `planet/__version__.py` to Next Dev Version | ||
| 1. Merge PR for release branch |
Contributor
There was a problem hiding this comment.
@jreiberkyle seems good to me. This process is more careful about the state of the main branch than I usually am, and that's good.
Contributor
Author
There was a problem hiding this comment.
Great! This is inspired by the OpenLayers release process (and succinct overview by @tschaub). I was glad to have a template to work from.
Contributor
Author
|
@sgillies your general thumbs up/down on changing the version in |
tschaub
reviewed
Oct 14, 2022
Co-authored-by: Tim Schaub <tschaub@users.noreply.github.com>
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.
mainis the name of the next release +dev, a post-release stepAttribution: this is inspired by the openlayers release process.
Closes #691