# Editorial Workflows

Source: https://decapcms.org/docs/editorial-workflows/ (updated 2026-10-26)



By default, saving a post in the CMS interface pushes a commit directly to the publication branch specified in `backend`. However, you also have the option to edit the [Publish Mode](https://decapcms.org/docs/configuration-options/#publish-mode), which adds an interface for drafting, reviewing, and approving posts. To do this, add the following line to your Decap CMS `config.yml`:

```yaml
# This line should *not* be indented
publish_mode: editorial_workflow
```

From a technical perspective, the workflow translates editor UI actions into common Git commands:

| Actions in Netlify UI     | Perform these Git actions                                                                                         |
| ------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| Save draft                | Commits to a new branch (named according to the pattern `cms/collectionName/entrySlug`), and opens a pull request |
| Edit draft                | Pushes another commit to the draft branch/pull request                                                            |
| Approve and publish draft | Merges pull request and deletes branch                                                                            |

**Note:** Editorial workflow works with GitHub repositories, and supports [GitLab](https://decapcms.org/docs/gitlab-backend/), [Bitbucket](https://decapcms.org/docs/bitbucket-backend/), [Azure](https://decapcms.org/docs/azure-backend/), [Forgejo](https://decapcms.org/docs/gitea-backend/#forgejo-backend), [Git Gateway](https://decapcms.org/docs/git-gateway-backend/) and [Decap Turbo](https://decapcms.org/docs/turbo-overview/). The `gitea` backend doesn't support it.


### Bitbucket Support

In order to track unpublished entries statuses, the Bitbucket implementation uses
[pull requests comments](https://confluence.atlassian.com/bitbucketserver/commenting-on-a-pull-request-1027119882.html).

### GitLab Support

In order to track unpublished entries statuses, the GitLab implementation uses
[merge requests labels](https://docs.gitlab.com/ee/user/project/labels.html).

### Forgejo Support

Editorial workflow on Forgejo needs the [`forgejo` backend](https://decapcms.org/docs/gitea-backend/#forgejo-backend). In order to track unpublished entries statuses, the Forgejo implementation uses pull request labels, which it creates when they're missing.


## Unpublished entries in collections

<span class="version-tag">3.8</span>

Besides the Workflow page, unpublished entries also appear in their collection. Each entry with unpublished changes, including a published entry that is being edited, shows a badge with its status: **Draft**, **In review** or **Ready**.

Entries that haven't been published yet are listed below the published ones, under an **Unpublished Entries** heading, and sorted like the rest of the collection. When the collection is [grouped](https://decapcms.org/docs/configuration-options/#view_groups), they're listed once, below all the groups. [View filters](https://decapcms.org/docs/configuration-options/#view_filters) don't apply to them. <span class="version-tag">3.15</span>

## Squash merge GitHub pull requests

When using the **Editorial Workflow** with the `github` or GitHub-connected `git-gateway` backends, Decap 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.

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.

To enable this feature, you can set the following option in your Decap CMS `config.yml`:

```yaml
backend:
  squash_merges: true
```