Skip to content

Commit b644032

Browse files
committed
update docs
1 parent 48c1b2f commit b644032

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

website/site/content/docs/beta-features.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,11 @@ CMS.registerPreviewStyle(styles.toString(), { raw: true })
7878
```
7979

8080
## Squash merge GitHub pull requests
81-
When using the [Editorial Workflow publish mode](/docs/configuration-options/#publish-mode) with the `github` or `git-gateway` backends, Netlify CMS creates pull requests to hold drafts while they are being edited and then merges them into your main branch when you press publish. By default, these are merged preserving the history of all the individual commits. In other words, you will have a commit in your history for every time you pressed the save button.
81+
When using the [Editorial Workflow](/docs/configuration-options/#publish-mode) with the `github` or `git-gateway` backends, Netlify CMS creates a pull request for each unpublished entry. Every time the unpublished entry is changed and saved, a new commit is added to the pull request. When the entry is published, the pull request is merged, and all of those commits are added to your project commit history in a merge commit.
8282

83-
If instead you would like to [“squash”](https://help.github.com/articles/about-pull-request-merges/#squash-and-merge-your-pull-request-commits) these commits into a single commit, reducing clutter in your repository’s history, you can set the following option in your `config.yml`:
83+
The squash merge option causes all commits to be "squashed" into a single commit when the pull request is merged, and the resulting commit is rebased onto the target branch, avoiding the merge commit altogether.
84+
85+
To enable this feature, you can set the following option in your `config.yml`:
8486

8587
```yaml
8688
backend:

0 commit comments

Comments
 (0)