Skip to content

Document release actions in audit logs #3443

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

Merged
pwizla merged 2 commits into from
Sep 15, 2026
+28 −0
Merged

Document release actions in audit logs #3443

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a1b6f27
Document release actions in audit logs
github-actions[bot] Sep 4, 2026
df19de6
Apply suggestion from @pwizla
pwizla Sep 4, 2026
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
3 changes: 3 additions & 0 deletions docusaurus/docs/cms/features/audit-logs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,9 @@ The Audit Logs feature logs the following events:
| Entry (draft/publish) | `create`, `update`, `delete`, `publish`, `unpublish` |
| Media | `create`, `update`, `delete` |
| Login / Logout | `success`, `fail` |
| Releases | `create`, `update`, `delete`, `trigger` |
| Release entries | `add`, `update`, `remove` |
| Release settings | `update` |
| Role / Permission | `create`, `update`, `delete` |
| User | `create`, `update`, `delete` |

Expand Down
25 changes: 25 additions & 0 deletions docusaurus/docs/cms/features/releases.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,3 +216,28 @@ Once a release is published, the release itself cannot be updated. You can not r
dark: '/img/assets/releases/publish-release_DARK.png',
}}
/>

### Audit logging of release actions

<EnterpriseBadge />

Release actions are automatically captured in [Audit Logs](/cms/features/audit-logs) for Enterprise plan users. Every significant change to a release, its entries, or its settings produces a log entry, regardless of whether the action came from the admin panel or a scheduled job.

The following actions are recorded:

| Action | What is logged |
| --- | --- |
| Create release | The new release name, and whether it was scheduled. |
| Update release | The fields that changed (name, schedule date, timezone) and their previous and new values. No entry is created if nothing changed. |
| Delete release | The deleted release identifier. |
| Trigger release | The number of entries published or unpublished and the outcome: `success` or `failure` (error name only, no internal details). |
| Add entry to release | One log entry per entry added, with the content type, document ID, locale, and action type (`publish` or `unpublish`). |
| Change entry on release | The previous and new action type (`publish` ↔ `unpublish`). No entry is created if nothing changed. |
| Remove entry from release | The entry that was explicitly removed from the release. |
| Update release settings | The previous and new default timezone value. No entry is created if nothing changed. |

Each log record includes the actor (user name, or `-` for scheduled triggers), the origin (`admin` for manual actions, `scheduler` for automatic ones), and the resource affected. To view release log entries, go to <Icon name="gear-six" /> **Settings > Audit Logs** and look for entries prefixed with *release*.

:::note
Deleting an entry or a locale that happens to be in a pending release does not create a "Remove entry from release" log. Only explicit removal is recorded. The delete action on the entry or locale itself is logged separately.
:::
Loading