chore: add additional instructions for hotfixes in release.md #6971
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## unstable #6971 +/- ##
============================================
- Coverage 62.49% 62.49% -0.01%
============================================
Files 576 576
Lines 61180 61170 -10
Branches 2131 2133 +2
============================================
- Hits 38234 38226 -8
+ Misses 22907 22905 -2
Partials 39 39 |
nflaig
reviewed
Jul 19, 2024
Performance Report✔️ no performance regression detected Full benchmark results
|
wemeetagain
reviewed
Jul 22, 2024
RELEASE.md
Outdated
| - Merge `chore: v1.1.1 release` PR to stable **with "merge commit"** strategy to preserve all history. | ||
| - Merge stable `stable` into `unstable` **with merge commit** strategy. Due to branch protections in `unstable` must open a PR. If there are conflicts, those must be resolved manually. Gitflow may cause changes that conflict between stable and unstable, for example due to a hotfix that is backported. If that happens, disable branch protections in unstable, merge locally fixing conflicts, run lint + tests, push, and re-enable branch protections. See "Backporting merge conflicts from stable to unstable". | ||
|
|
||
| #### Backporting merge conflicts from stable to unstable |
There was a problem hiding this comment.
This section applies to both hotfix releases and normal releases. Consider moving to an appendix or duplicating for both lists.
There was a problem hiding this comment.
I considered this, but instead of jumping back and forth between different parts of the doc for a minor bump vs hotfix bump, it would be easier to lay it out the process sequentially, even if some of it is repetitive. This way if you're doing a hotfix bump, you can just stick to that section.
Co-authored-by: Cayman <caymannava@gmail.com>
Co-authored-by: Cayman <caymannava@gmail.com>
|
Ready for final reviews if required. |
nflaig
reviewed
Jul 24, 2024
nflaig
reviewed
Jul 26, 2024
Co-authored-by: Nico Flaig <nflaig@protonmail.com>
nflaig
approved these changes
Jul 28, 2024
|
🎉 This PR is included in v1.21.0 🎉 |
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.
Motivation
This PR is to give clearer instructions on how to deal with merge conflicts arising from hotfixes and backporting into unstable.
Description
Due to the unusual nature of merging stable back to unstable, sometimes with conflicts, it's important to provide more verbose instructions to document how to accomplish this successfully.