docs: disallow rebase merges#287
Open
njoyard wants to merge 1 commit into
Open
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
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.
Rebase merges produce a git history that does not include PR numbers, which makes
github-changelogfail to generate a proper changelog.Doing a merge with rebase on a repository with
release-planwill produce aPrepare release vnullPR with a faulty.release-plan.jsonand empty changelog:{ "solution": { "@org/package": { "oldVersion": "1.2.3" } }, "description": "\n\n\n\n" }This PR updates the README and
RELEASE.mdto suggest disabling rebase merging on their repositories.