Skip to content

docs: disallow rebase merges#287

Open
njoyard wants to merge 1 commit into
release-plan:mainfrom
njoyard:docs/disallow-rebase-merges
Open

docs: disallow rebase merges#287
njoyard wants to merge 1 commit into
release-plan:mainfrom
njoyard:docs/disallow-rebase-merges

Conversation

@njoyard

@njoyard njoyard commented Jun 4, 2026

Copy link
Copy Markdown

Rebase merges produce a git history that does not include PR numbers, which makes github-changelog fail to generate a proper changelog.

Doing a merge with rebase on a repository with release-plan will produce a Prepare release vnull PR with a faulty .release-plan.json and empty changelog:

{
  "solution": {
    "@org/package": {
      "oldVersion": "1.2.3"
    }
  },
  "description": "\n\n\n\n"
}

This PR updates the README and RELEASE.md to suggest disabling rebase merging on their repositories.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant