docs: update LOTUS_RELEASE_FLOW with recent FAQs and branch/tag strategy items #12364
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
|
@rjan90 : I didn't want to just push these larger changes to #12322 . This PR also doesn't include my suggestions in #12322 . I assume the best sequence of events is:
|
8 tasks
BigLep
commented
Aug 9, 2024
rjan90
reviewed
Aug 9, 2024
LOTUS_RELEASE_FLOW.md
Outdated
Comment on lines
99
to
101
| * Releases branches have the name `release/vX.Y.Z` | ||
| * By the end of the release process, a `release/vX.Y.Z` branch will have an associated `vX.Y.Z` tag and likely also `vX.Y.Z-rcN` tags. | ||
| * `master` branch is almost always where `release/vX.Y.Z` branches are created from. The exception is we need to do an emergency rushed patch release and can't risk pulling in other changes that have already landed in `master`. In that case, `release/vX.Y.Z+1` will be created from `release/vX.Y.Z`. |
There was a problem hiding this comment.
I think we have to think a little bit more about these lines, and how we can convey the branching strategy with the separation of Node and Miner. Ref: #12096 (comment)
release/vX.Y.Zbranches for node releasesrelease/miner/vX.Y.Zbranches for miner releases- By the end of the release process:
- A
release/miner/vX.Y.Zbranch will have an associatedminer/vX.Y.Ztag to it - A
release/vX.Y.Zbranch will have an associatedvX.Y.Ztag to it.
- A
Writing this in text can be a little bit confusing given the similar looking nature of these branches.
There was a problem hiding this comment.
Good point! I like your expanded text. We could also do colors to help differentiate? https://stackoverflow.com/questions/35465557/how-to-apply-color-on-text-in-markdown. Feel free to adjust/merge or I can try this out when more at the keyboard a bit later today.
There was a problem hiding this comment.
Expanded the text to differentiate between node/miner, as well as colouring in: 4d7080a
docs: Clarify node/miner release branching
BigLep
commented
Aug 9, 2024
There was a problem hiding this comment.
FYI that in the GitHub UI I'm not seeing colors (looking at https://github.com/filecoin-project/lotus/blob/4d7080a689a7449678b37c5fc1dab80ef5689679/LOTUS_RELEASE_FLOW.md )
Co-authored-by: Steve Loeppky <[email protected]>
Co-authored-by: Steve Loeppky <[email protected]>
rjan90
added a commit
that referenced
this pull request
Aug 12, 2024
…egy items (#12364) * docs: update LOTUS_RELEASE_FLOW with recent FAQs and branch/tag strategy items This was done as additional content to potentially add per #12322 . It includes content I saw in #12020 and #12072 that wasn't previously included. * Updates from self-review. * docs: Clarify node/miner release branching docs: Clarify node/miner release branching * Update LOTUS_RELEASE_FLOW.md Co-authored-by: Steve Loeppky <[email protected]> * Update LOTUS_RELEASE_FLOW.md Co-authored-by: Steve Loeppky <[email protected]> --------- Co-authored-by: Phi <[email protected]>
rjan90
added a commit
that referenced
this pull request
Aug 12, 2024
* Preliminary update to the LOTUS_RELEASE_FLOW document Preliminary update to the LOTUS_RELEASE_FLOW document * docs: update LOTUS_RELEASE_FLOW with recent FAQs and branch/tag strategy items (#12364) * docs: update LOTUS_RELEASE_FLOW with recent FAQs and branch/tag strategy items This was done as additional content to potentially add per #12322 . It includes content I saw in #12020 and #12072 that wasn't previously included. * Updates from self-review. * docs: Clarify node/miner release branching docs: Clarify node/miner release branching * Update LOTUS_RELEASE_FLOW.md Co-authored-by: Steve Loeppky <[email protected]> * Update LOTUS_RELEASE_FLOW.md Co-authored-by: Steve Loeppky <[email protected]> --------- Co-authored-by: Phi <[email protected]> * Apply @BigLep suggestions from code review These were self-committed to make it easier to propose additional changes on top. * Apply remaining @BigLep suggestions from code review * Added terminology section * More editing Major items were answering: Why isn't Lotus Miner released more frequently? Why is the `releases` branch deprecated and what are alternatives? * Update LOTUS_RELEASE_FLOW.md Co-authored-by: Steve Loeppky <[email protected]> * fix: double spacing and minor typos fix: double spacing and minor typos * fix(docs): link to LOTUS_RELEASE_FLOW.md from CONTRIBUTING.md fix(docs): link to LOTUS_RELEASE_FLOW.md from CONTRIBUTING.md --------- Co-authored-by: Steve Loeppky <[email protected]> Co-authored-by: Steve Loeppky <[email protected]>
8 tasks
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.
This was done as additional content to potentially add for #12322 . It includes content I saw in #12020 and #12072 that wasn't previously included.