Skip to content

Add notice syntax in changesets #743

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
ComfortablyCoding merged 3 commits into from
Jun 16, 2026
Merged

Add notice syntax in changesets #743

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
15ada2f
add notice syntax in changesets
ComfortablyCoding Jun 16, 2026
a5f9ee7
add notice
ComfortablyCoding Jun 16, 2026
061845b
small adjustments
ComfortablyCoding Jun 16, 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
34 changes: 34 additions & 0 deletions content/community/2.contribution/4.pull-requests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,37 @@ The following are the types of version bumps that can be specified in a changese
- Major (x.0.0) - A change has been made that is incompatible with previous versions.
- Minor (0.x.0) - A feature has been added that is backwards compatible with previous versions.
- Patch (0.0.x) - A bug has been fixed that is backwards compatible with previous versions.

### Notices

Use a notice for changes that deserve extra visibility in the release notes, such as deprecations, required migrations, or behavior changes that users upgrading and/or extension authors should be aware of.

Add a `::: notice` block at the end of the changeset body:

```markdown
---
"@directus/app": minor
---

Deprecated the `VResizeable` component

::: notice

- Deprecation for extensions: The globally registered `VResizeable` component has been deprecated. Extension authors should migrate to `@directus/vue-split-panel` or provide their own implementation.

:::
```

The notice is extracted and displayed in the **Potential Breaking Changes** section at the top of the release notes. The rest of the changeset remains in its normal category.

Notices always appear under **Potential Breaking Changes**, regardless of whether the changeset is a major, minor, or patch release. Adding a notice does not affect the version bump. Choose the bump type based on the impact of the change, and add a notice whenever the change warrants additional attention.

**Notice detection is strict.** If the syntax does not match exactly, the notice will not be extracted.

To ensure your notice is recognized:

- Start the block with exactly `::: notice`: all lowercase, with a single space between `:::` and `notice`.
- End the block with `:::` on its own line.
- Do not indent the opening or closing markers, or include trailing whitespace.
- Include some content between the markers. An empty block is not detected.
- Include exactly one notice block per changeset. Multiple notce blocks will result in a malformed output
Loading