Skip to content

docs(config): document backend.signoff_commits option (DCMS-442) #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sempostma wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(config): document backend.signoff_commits option (DCMS-442) #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions content/docs/configuration-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,26 @@ Template tags produce the following output:
* `{{author-login}}`: the login/username of the author
* `{{author-name}}`: the full name of the author (might be empty based on the user's profile)

### Sign Off Commits

You can have Decap CMS append a git-style `Signed-off-by` trailer to every commit message (create, update, delete, and media operations) by setting the `signoff_commits` option under `backend` in your Decap CMS `config.yml`.

```yaml
backend:
signoff_commits: true
```

- Type: `boolean`
- Default: `false`

When enabled, the trailer is built from the current user's name and email, in the same style used by `git commit --signoff`:

```
Signed-off-by: Jane Doe <jane@example.com>
```

If the user's name or email is unavailable, Decap CMS logs a console warning and skips adding the trailer for that commit.

## Publish Mode

By default, all entries created or edited in the Decap CMS are committed directly into the main repository branch. The `publish_mode` option allows you to enable [Editorial Workflow](/docs/editorial-workflows/) mode for more control over the content publishing phases. You can enable the Editorial Workflow with the following line in your Decap CMS `config.yml` file:
Expand Down