docs: Add engine scope to PR title conventions (no-changelog) (#36434)

This commit is contained in:
Tomi Turtiainen
2026-08-17 11:55:49 +00:00
committed by GitHub
parent e5d3093f78
commit a5e3213df4
2 changed files with 7 additions and 4 deletions
+2 -1
View File
@@ -11,7 +11,7 @@ A PR title consists of these elements:
| | Capitalized
| | No period at the end.
│ │
│ └─⫸ Scope: API | benchmark | core | editor | * Node
│ └─⫸ Scope: API | benchmark | core | editor | engine | * Node
│
└─⫸ Type: build | ci | chore | docs | feat | fix | perf | refactor | test
```
@@ -53,6 +53,7 @@ The scope should specify the place of the commit change as long as the commit cl
- `benchmark` - changes to the benchmark cli
- `core` - changes to the core / private API / backend of n8n
- `editor` - changes to the Editor UI
- `engine` - changes to the new workflow execution engine v2
- `* Node` - changes to a specific node or trigger node (”`*`” to be replaced with the node name, not its display name), e.g.
- mattermost → Mattermost Node
- microsoftToDo → Microsoft To Do Node
+5 -3
View File
@@ -27,10 +27,12 @@ const changelogStream = new ConventionalChangelog()
releaseCount: 1,
transformCommit(commit) {
const hasNoChangelogInHeader = commit.header?.includes('(no-changelog)');
const isBenchmarkScope = commit.scope === 'benchmark';
// 'engine' is ignored for now. We will show it in the changelog when the engine is stable.
const ignoredScopes = ['benchmark', 'engine'];
const hasIgnoredScope = ignoredScopes.includes(commit.scope);
// Ignore commits that have 'benchmark' scope or '(no-changelog)' in the header
if (hasNoChangelogInHeader || isBenchmarkScope) return null;
// Ignore commits that have an ignored scope or '(no-changelog)' in the header
if (hasNoChangelogInHeader || hasIgnoredScope) return null;
// Strip backport information from commit subject, e.g.:
// "Fix something (backport to release-candidate/2.12.x) (#123)" → "Fix something (#123)"