@williamthorsen/release-kit 12.0.0 โ 13.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.meta/changelog.json +212 -0
- package/.readyup/kits/default.js +18 -17
- package/.readyup/kits/npm-auto-publish.js +24 -23
- package/.readyup/manifest.json +16 -11
- package/CHANGELOG.md +58 -0
- package/README.md +55 -48
- package/bin/release-kit.js +1 -1
- package/dist/esm/assertCleanWorkingTree.d.ts +1 -5
- package/dist/esm/assertTaggedBaseline.d.ts +29 -0
- package/dist/esm/assertTaggedBaseline.js +41 -0
- package/dist/esm/attachChangelogDiagnostics.d.ts +1 -1
- package/dist/esm/attachChangelogDiagnostics.js +3 -0
- package/dist/esm/bin/release-kit.js +85 -22
- package/dist/esm/buildChangelogEntries.d.ts +23 -13
- package/dist/esm/buildChangelogEntries.js +36 -17
- package/dist/esm/buildDependencyGraph.d.ts +6 -6
- package/dist/esm/buildEmptyReleaseEntry.d.ts +1 -8
- package/dist/esm/buildReleaseSummary.d.ts +2 -8
- package/dist/esm/buildSyntheticChangelogEntry.d.ts +3 -5
- package/dist/esm/buildSyntheticChangelogEntry.js +2 -2
- package/dist/esm/bumpVersion.d.ts +1 -8
- package/dist/esm/changelogJsonFile.d.ts +5 -7
- package/dist/esm/changelogJsonFile.js +2 -17
- package/dist/esm/changelogJsonUtils.d.ts +7 -10
- package/dist/esm/changelogOverrides.d.ts +59 -98
- package/dist/esm/classifyChangelogCommit.d.ts +7 -9
- package/dist/esm/classifyChangelogCommit.js +3 -2
- package/dist/esm/commitCommand.d.ts +2 -4
- package/dist/esm/compareVersions.d.ts +10 -4
- package/dist/esm/compareVersions.js +16 -0
- package/dist/esm/configFlagSchema.d.ts +1 -1
- package/dist/esm/createGithubRelease.d.ts +7 -19
- package/dist/esm/createGithubReleaseCommand.d.ts +5 -5
- package/dist/esm/createGithubReleaseCommand.js +9 -9
- package/dist/esm/createTags.d.ts +2 -3
- package/dist/esm/decideRelease.d.ts +2 -6
- package/dist/esm/defaults.d.ts +5 -24
- package/dist/esm/defaults.js +4 -5
- package/dist/esm/defineConfig.d.ts +1 -1
- package/dist/esm/deleteFileIfExists.d.ts +1 -1
- package/dist/esm/deriveReleaseNotesConfig.d.ts +20 -0
- package/dist/esm/deriveReleaseNotesConfig.js +21 -0
- package/dist/esm/deriveWorkspaceConfig.d.ts +3 -5
- package/dist/esm/detectPackageManager.d.ts +2 -4
- package/dist/esm/detectUndeclaredTagPrefixes.d.ts +4 -6
- package/dist/esm/detectUndeclaredTagPrefixes.js +1 -1
- package/dist/esm/determineBumpType.d.ts +1 -1
- package/dist/esm/discoverWorkspaces.d.ts +14 -15
- package/dist/esm/discoverWorkspaces.js +12 -12
- package/dist/esm/enterRepoRoot.d.ts +12 -0
- package/dist/esm/enterRepoRoot.js +16 -0
- package/dist/esm/enumerateReleaseWindows.d.ts +8 -8
- package/dist/esm/extractMigration.d.ts +6 -8
- package/dist/esm/findUnroutedEntryScopes.d.ts +16 -0
- package/dist/esm/findUnroutedEntryScopes.js +57 -0
- package/dist/esm/formatExcludedSkip.d.ts +3 -0
- package/dist/esm/formatExcludedSkip.js +3 -0
- package/dist/esm/formatPrivateSkip.d.ts +1 -6
- package/dist/esm/generateChangelogs.d.ts +10 -5
- package/dist/esm/glyphs.d.ts +1 -1
- package/dist/esm/help/prepareHelp.d.ts +3 -4
- package/dist/esm/help/prepareHelp.js +4 -3
- package/dist/esm/init/checks.d.ts +3 -3
- package/dist/esm/init/checks.js +4 -1
- package/dist/esm/init/detectRepoType.d.ts +2 -3
- package/dist/esm/init/hasProvenance.d.ts +2 -0
- package/dist/esm/init/hasProvenance.js +3 -0
- package/dist/esm/init/initCommand.d.ts +3 -6
- package/dist/esm/init/initCommand.js +10 -10
- package/dist/esm/init/parseJsonRecord.d.ts +1 -4
- package/dist/esm/init/scaffold.d.ts +1 -1
- package/dist/esm/init/templates.d.ts +9 -11
- package/dist/esm/init/templates.js +12 -11
- package/dist/esm/init/updateTemplatesCommand.d.ts +13 -0
- package/dist/esm/init/updateTemplatesCommand.js +64 -0
- package/dist/esm/injectReleaseNotesIntoReadme.d.ts +12 -17
- package/dist/esm/injectSection.d.ts +3 -3
- package/dist/esm/loadConfig.d.ts +16 -14
- package/dist/esm/loadConfig.js +2 -2
- package/dist/esm/loadValidatedConfig.d.ts +16 -19
- package/dist/esm/loadValidatedConfig.js +6 -1
- package/dist/esm/packsPath.d.ts +9 -9
- package/dist/esm/parseChangeRecordBlock.d.ts +2 -2
- package/dist/esm/parseCommitMessage.d.ts +17 -32
- package/dist/esm/parseCommitMessage.js +28 -37
- package/dist/esm/parseRequestedTags.d.ts +3 -3
- package/dist/esm/planReleaseNotesPreviews.d.ts +6 -6
- package/dist/esm/planVersionBump.d.ts +5 -3
- package/dist/esm/planVersionBump.js +3 -0
- package/dist/esm/prepareCommand.d.ts +4 -7
- package/dist/esm/prepareCommand.js +13 -6
- package/dist/esm/previewTagPrefixes.d.ts +8 -10
- package/dist/esm/propagateBumps.d.ts +6 -7
- package/dist/esm/publish.d.ts +1 -1
- package/dist/esm/publishCommand.d.ts +4 -3
- package/dist/esm/publishCommand.js +8 -8
- package/dist/esm/pushCommand.d.ts +4 -3
- package/dist/esm/pushCommand.js +8 -2
- package/dist/esm/pushRelease.d.ts +2 -2
- package/dist/esm/readChangelogSections.d.ts +33 -0
- package/dist/esm/readChangelogSections.js +80 -0
- package/dist/esm/releaseFiles.d.ts +5 -7
- package/dist/esm/releasePlan.d.ts +11 -13
- package/dist/esm/releasePrepare.d.ts +23 -22
- package/dist/esm/releasePrepare.js +31 -11
- package/dist/esm/releasePrepareMono.d.ts +9 -7
- package/dist/esm/releasePrepareMono.js +85 -33
- package/dist/esm/releasePrepareProject.d.ts +19 -29
- package/dist/esm/releasePrepareProject.js +31 -12
- package/dist/esm/renderChangelogMarkdown.d.ts +10 -4
- package/dist/esm/renderChangelogMarkdown.js +27 -2
- package/dist/esm/renderReleaseNotes.d.ts +3 -11
- package/dist/esm/renderReleaseNotes.js +2 -6
- package/dist/esm/reportPrepare.d.ts +4 -5
- package/dist/esm/reportPrepare.js +33 -19
- package/dist/esm/resolveCommandTags.d.ts +15 -11
- package/dist/esm/resolveCommandTags.js +35 -5
- package/dist/esm/resolveConfigFlag.d.ts +7 -0
- package/dist/esm/resolveConfigFlag.js +4 -0
- package/dist/esm/resolveReleaseTags.d.ts +6 -8
- package/dist/esm/resolveReleaseTags.js +1 -1
- package/dist/esm/resolveStylesOrExit.d.ts +2 -2
- package/dist/esm/showTagPrefixesCommand.d.ts +7 -10
- package/dist/esm/showTagPrefixesCommand.js +4 -4
- package/dist/esm/stripEmojiPrefix.d.ts +1 -0
- package/dist/esm/stripScope.d.ts +2 -2
- package/dist/esm/stripScope.js +3 -3
- package/dist/esm/sync-labels/generateCommand.d.ts +11 -10
- package/dist/esm/sync-labels/generateCommand.js +11 -8
- package/dist/esm/sync-labels/initCommand.d.ts +6 -7
- package/dist/esm/sync-labels/initCommand.js +2 -2
- package/dist/esm/sync-labels/presets.d.ts +5 -4
- package/dist/esm/sync-labels/presets.js +9 -9
- package/dist/esm/sync-labels/resolveLabels.d.ts +7 -7
- package/dist/esm/sync-labels/resolveLabels.js +1 -1
- package/dist/esm/sync-labels/retiredConfig.d.ts +4 -5
- package/dist/esm/sync-labels/syncCommand.d.ts +1 -4
- package/dist/esm/sync-labels/templates.d.ts +3 -3
- package/dist/esm/sync-labels/templates.js +3 -3
- package/dist/esm/sync-labels/typeLabels.d.ts +14 -0
- package/dist/esm/sync-labels/typeLabels.js +38 -0
- package/dist/esm/sync-labels/types.d.ts +1 -1
- package/dist/esm/tagCommand.d.ts +1 -1
- package/dist/esm/typeGuards.d.ts +2 -2
- package/dist/esm/types.d.ts +116 -91
- package/dist/esm/types.js +1 -1
- package/dist/esm/validateConfig.d.ts +2 -11
- package/dist/esm/validateConfig.js +2 -2
- package/dist/esm/validateOnlyExcludesStrandedDependents.d.ts +14 -12
- package/dist/esm/validateOverridesCommand.d.ts +17 -20
- package/dist/esm/validateOverridesCommand.js +1 -1
- package/docs/api.md +6 -6
- package/docs/changelogs.md +63 -40
- package/docs/configuration.md +29 -27
- package/docs/editorial-overrides.md +23 -23
- package/docs/labels.md +21 -19
- package/docs/project-releases.md +13 -13
- package/docs/publishing.md +5 -5
- package/docs/readiness-checks.md +3 -3
- package/docs/releasing.md +50 -25
- package/docs/work-types.md +41 -57
- package/package.json +7 -6
- package/presets/labels/common.yaml +1 -41
- package/dist/esm/resolveReleaseNotesConfig.d.ts +0 -26
- package/dist/esm/resolveReleaseNotesConfig.js +0 -29
- package/dist/esm/workTypesData.d.ts +0 -50
- package/dist/esm/workTypesData.js +0 -145
- package/schemas/label-map.json +0 -24
|
@@ -1,37 +1,17 @@
|
|
|
1
1
|
# Common label definitions for GitHub repositories.
|
|
2
2
|
# Compatible with EndBug/label-sync format.
|
|
3
|
+
# Work-type labels are built from change-grammar's taxonomy in src/sync-labels/typeLabels.ts.
|
|
3
4
|
|
|
4
5
|
# Main categories
|
|
5
|
-
- name: ai
|
|
6
|
-
color: a2eeef
|
|
7
|
-
description: Guidance on working in this repo, such as its AGENTS.md or a repo-local skill, or its agent config
|
|
8
6
|
- name: breaking
|
|
9
7
|
color: b60205
|
|
10
8
|
description: Breaking API change or removal of functionality
|
|
11
9
|
- name: bug
|
|
12
10
|
color: d73a4a
|
|
13
11
|
description: "Something isn't working"
|
|
14
|
-
- name: deprecation
|
|
15
|
-
color: fbca04
|
|
16
|
-
description: Marks functionality for future removal
|
|
17
|
-
- name: documentation
|
|
18
|
-
color: a2eeef
|
|
19
|
-
description: Documentation for human readers, such as a README, a guide, or a code comment
|
|
20
|
-
- name: feature
|
|
21
|
-
color: '0075ca'
|
|
22
|
-
description: Added or improved external functionality
|
|
23
|
-
- name: fix
|
|
24
|
-
color: d73a4a
|
|
25
|
-
description: Fixes a bug
|
|
26
12
|
- name: operational
|
|
27
13
|
color: '000000'
|
|
28
14
|
description: Actions outside the codebase
|
|
29
|
-
- name: performance
|
|
30
|
-
color: '0075ca'
|
|
31
|
-
description: Improves performance without changing behavior
|
|
32
|
-
- name: security
|
|
33
|
-
color: b60205
|
|
34
|
-
description: Security vulnerability or hardening
|
|
35
15
|
- name: spike
|
|
36
16
|
color: '000000'
|
|
37
17
|
description: Investigation
|
|
@@ -47,26 +27,6 @@
|
|
|
47
27
|
color: fbca04
|
|
48
28
|
description: Further information is needed
|
|
49
29
|
|
|
50
|
-
# Refactoring
|
|
51
|
-
- name: ci
|
|
52
|
-
color: edc287
|
|
53
|
-
description: CI/CD tooling & configuration
|
|
54
|
-
- name: dependencies
|
|
55
|
-
color: edc287
|
|
56
|
-
description: Change to dependencies
|
|
57
|
-
- name: internal
|
|
58
|
-
color: 1d76db
|
|
59
|
-
description: Internal change without external impact
|
|
60
|
-
- name: refactoring
|
|
61
|
-
color: edc287
|
|
62
|
-
description: Improvement to code without change in functionality
|
|
63
|
-
- name: tests
|
|
64
|
-
color: edc287
|
|
65
|
-
description: Tests
|
|
66
|
-
- name: tooling
|
|
67
|
-
color: edc287
|
|
68
|
-
description: Development tools
|
|
69
|
-
|
|
70
30
|
# Priority
|
|
71
31
|
- name: 'priority:critical'
|
|
72
32
|
color: b60205
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
import type { OutputStyle } from '@williamthorsen/nmr-core';
|
|
2
|
-
import type { ReleaseNotesConfig } from './types.js';
|
|
3
|
-
export interface ResolvedReleaseNotesConfig {
|
|
4
|
-
releaseNotes: ReleaseNotesConfig;
|
|
5
|
-
changelogJsonOutputPath: string;
|
|
6
|
-
/** Section titles in priority order, derived from the merged workTypes record. */
|
|
7
|
-
sectionOrder: string[];
|
|
8
|
-
}
|
|
9
|
-
export interface ResolveReleaseNotesConfigOptions {
|
|
10
|
-
/** Config file to read, relative to the working directory. Defaults to `CONFIG_FILE_PATH`. */
|
|
11
|
-
configPath?: string;
|
|
12
|
-
}
|
|
13
|
-
/**
|
|
14
|
-
* Loads and validates the release-kit config, resolving the release-notes settings it carries.
|
|
15
|
-
*
|
|
16
|
-
* An unusable config reports to stderr and calls `process.exit(1)`, whether the file failed to load or failed
|
|
17
|
-
* validation, and whether it was named by the caller or the default one. Both callers are CLI commands whose
|
|
18
|
-
* whole behavior depends on the resolved config, so neither could proceed on derived defaults without silently
|
|
19
|
-
* dropping a configured `releaseNotes.shouldInjectIntoReadme`, `changelogJson.outputPath`, or `workTypes`.
|
|
20
|
-
* An absent default config is a supported state and resolves to the defaults.
|
|
21
|
-
*/
|
|
22
|
-
export declare function resolveReleaseNotesConfig(stderrStyle: OutputStyle, options?: ResolveReleaseNotesConfigOptions): Promise<ResolvedReleaseNotesConfig>;
|
|
23
|
-
/** Extract section headers in declaration order from a merged workTypes record. */
|
|
24
|
-
export declare function deriveSectionOrder(workTypes: Record<string, {
|
|
25
|
-
header: string;
|
|
26
|
-
}>): string[];
|
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
import { DEFAULT_CHANGELOG_JSON_CONFIG, DEFAULT_RELEASE_NOTES_CONFIG } from "./defaults.js";
|
|
2
|
-
import { resolveWorkTypes } from "./loadConfig.js";
|
|
3
|
-
import { loadValidatedConfig, reportConfigProblem, reportConfigWarnings } from "./loadValidatedConfig.js";
|
|
4
|
-
export async function resolveReleaseNotesConfig(stderrStyle, options = {}) {
|
|
5
|
-
const result = await loadValidatedConfig(options.configPath);
|
|
6
|
-
if (result.status === 'invalid') {
|
|
7
|
-
reportConfigProblem(result.problem, stderrStyle);
|
|
8
|
-
process.exit(1);
|
|
9
|
-
}
|
|
10
|
-
if (result.status === 'missing') {
|
|
11
|
-
return {
|
|
12
|
-
releaseNotes: { ...DEFAULT_RELEASE_NOTES_CONFIG },
|
|
13
|
-
changelogJsonOutputPath: DEFAULT_CHANGELOG_JSON_CONFIG.outputPath,
|
|
14
|
-
sectionOrder: deriveSectionOrder(resolveWorkTypes()),
|
|
15
|
-
};
|
|
16
|
-
}
|
|
17
|
-
reportConfigWarnings(result.warnings, stderrStyle);
|
|
18
|
-
const { config } = result;
|
|
19
|
-
return {
|
|
20
|
-
releaseNotes: {
|
|
21
|
-
shouldInjectIntoReadme: config.releaseNotes?.shouldInjectIntoReadme ?? DEFAULT_RELEASE_NOTES_CONFIG.shouldInjectIntoReadme,
|
|
22
|
-
},
|
|
23
|
-
changelogJsonOutputPath: config.changelogJson?.outputPath ?? DEFAULT_CHANGELOG_JSON_CONFIG.outputPath,
|
|
24
|
-
sectionOrder: deriveSectionOrder(resolveWorkTypes(config.workTypes)),
|
|
25
|
-
};
|
|
26
|
-
}
|
|
27
|
-
export function deriveSectionOrder(workTypes) {
|
|
28
|
-
return Object.values(workTypes).map((entry) => entry.header);
|
|
29
|
-
}
|
|
@@ -1,50 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Canonical work-types data: the runtime mirror of `work-types.json`.
|
|
3
|
-
*
|
|
4
|
-
* `work-types.json` is release-kit's copy of the codeassembly canonical. This `.ts` mirror exists for
|
|
5
|
-
* runtime consumption: The compiler baseline does not enable JSON module imports, and a TS constant keeps
|
|
6
|
-
* `breakingPolicy` typed as its three-value union.
|
|
7
|
-
*
|
|
8
|
-
* `nmr work-types:sync` updates only the JSON, so copy its change here by hand. A drift test
|
|
9
|
-
* (`workTypesData.unit.test.ts`) asserts that this constant deep-equals the parsed contents of
|
|
10
|
-
* `work-types.json`.
|
|
11
|
-
*/
|
|
12
|
-
/** Schema for a single entry. */
|
|
13
|
-
export interface WorkTypeEntry {
|
|
14
|
-
tier: string;
|
|
15
|
-
key: string;
|
|
16
|
-
aliases: string[];
|
|
17
|
-
emoji: string;
|
|
18
|
-
label: string;
|
|
19
|
-
description: string;
|
|
20
|
-
breakingPolicy: 'forbidden' | 'optional' | 'required';
|
|
21
|
-
excludedFromChangelog?: boolean;
|
|
22
|
-
}
|
|
23
|
-
/**
|
|
24
|
-
* Schema for an orthogonal section marker (e.g., breaking-changes indicator).
|
|
25
|
-
*
|
|
26
|
-
* Stored as plain text โ consumers add formatting (bold, prefix punctuation) when
|
|
27
|
-
* constructing the rendered form. Keeps the SSOT format-agnostic across Markdown,
|
|
28
|
-
* HTML, terminal, and plain-text consumers.
|
|
29
|
-
*/
|
|
30
|
-
export interface MarkerEntry {
|
|
31
|
-
emoji: string;
|
|
32
|
-
label: string;
|
|
33
|
-
}
|
|
34
|
-
/** Schema for the full data. */
|
|
35
|
-
export interface WorkTypesData {
|
|
36
|
-
/** Semantic version of the data shape, as declared by the upstream canonical. */
|
|
37
|
-
version: string;
|
|
38
|
-
tiers: string[];
|
|
39
|
-
types: WorkTypeEntry[];
|
|
40
|
-
/**
|
|
41
|
-
* Cross-cutting section markers keyed by marker name. The `breaking` marker is
|
|
42
|
-
* canonical and required; additional keys are permitted for forward-compatibility.
|
|
43
|
-
*/
|
|
44
|
-
markers: {
|
|
45
|
-
[key: string]: MarkerEntry;
|
|
46
|
-
breaking: MarkerEntry;
|
|
47
|
-
};
|
|
48
|
-
}
|
|
49
|
-
/** Canonical work-types data, kept in lockstep with `work-types.json`. */
|
|
50
|
-
export declare const WORK_TYPES_DATA: WorkTypesData;
|
|
@@ -1,145 +0,0 @@
|
|
|
1
|
-
export const WORK_TYPES_DATA = {
|
|
2
|
-
version: '1.1.0',
|
|
3
|
-
tiers: ['public', 'internal', 'process'],
|
|
4
|
-
types: [
|
|
5
|
-
{
|
|
6
|
-
tier: 'public',
|
|
7
|
-
key: 'feat',
|
|
8
|
-
aliases: ['feature'],
|
|
9
|
-
emoji: '๐',
|
|
10
|
-
label: 'Features',
|
|
11
|
-
description: 'A change that gives consumers a new capability or extends an existing one.',
|
|
12
|
-
breakingPolicy: 'optional',
|
|
13
|
-
},
|
|
14
|
-
{
|
|
15
|
-
tier: 'public',
|
|
16
|
-
key: 'drop',
|
|
17
|
-
aliases: [],
|
|
18
|
-
emoji: '๐ชฆ',
|
|
19
|
-
label: 'Removed',
|
|
20
|
-
description: 'A change that removes a capability or surface on which consumers depend.',
|
|
21
|
-
breakingPolicy: 'required',
|
|
22
|
-
},
|
|
23
|
-
{
|
|
24
|
-
tier: 'public',
|
|
25
|
-
key: 'deprecate',
|
|
26
|
-
aliases: [],
|
|
27
|
-
emoji: '๐๏ธ',
|
|
28
|
-
label: 'Deprecated',
|
|
29
|
-
description: 'A change that marks a capability or surface for removal while the capability or surface keeps working.',
|
|
30
|
-
breakingPolicy: 'forbidden',
|
|
31
|
-
},
|
|
32
|
-
{
|
|
33
|
-
tier: 'public',
|
|
34
|
-
key: 'fix',
|
|
35
|
-
aliases: ['bugfix'],
|
|
36
|
-
emoji: '๐',
|
|
37
|
-
label: 'Bug fixes',
|
|
38
|
-
description: 'A change that corrects behavior that consumers meet and that differs from what was intended.',
|
|
39
|
-
breakingPolicy: 'optional',
|
|
40
|
-
},
|
|
41
|
-
{
|
|
42
|
-
tier: 'public',
|
|
43
|
-
key: 'sec',
|
|
44
|
-
aliases: ['security'],
|
|
45
|
-
emoji: '๐',
|
|
46
|
-
label: 'Security',
|
|
47
|
-
description: 'A change that closes a vulnerability or hardens a consumer-facing surface against attack.',
|
|
48
|
-
breakingPolicy: 'optional',
|
|
49
|
-
},
|
|
50
|
-
{
|
|
51
|
-
tier: 'public',
|
|
52
|
-
key: 'perf',
|
|
53
|
-
aliases: ['performance'],
|
|
54
|
-
emoji: 'โก',
|
|
55
|
-
label: 'Performance',
|
|
56
|
-
description: 'A change that reduces the time, memory, or other resources that consumer-facing work uses, without changing its result.',
|
|
57
|
-
breakingPolicy: 'optional',
|
|
58
|
-
},
|
|
59
|
-
{
|
|
60
|
-
tier: 'internal',
|
|
61
|
-
key: 'internal',
|
|
62
|
-
aliases: ['utility'],
|
|
63
|
-
emoji: '๐๏ธ',
|
|
64
|
-
label: 'Internal features',
|
|
65
|
-
description: 'A change that adds or extends a capability that consumers do not use directly, such as a helper or an internal module.',
|
|
66
|
-
breakingPolicy: 'forbidden',
|
|
67
|
-
},
|
|
68
|
-
{
|
|
69
|
-
tier: 'internal',
|
|
70
|
-
key: 'refactor',
|
|
71
|
-
aliases: [],
|
|
72
|
-
emoji: 'โป๏ธ',
|
|
73
|
-
label: 'Refactoring',
|
|
74
|
-
description: 'A change that restructures existing code without changing its behavior.',
|
|
75
|
-
breakingPolicy: 'forbidden',
|
|
76
|
-
},
|
|
77
|
-
{
|
|
78
|
-
tier: 'internal',
|
|
79
|
-
key: 'tests',
|
|
80
|
-
aliases: ['test'],
|
|
81
|
-
emoji: '๐งช',
|
|
82
|
-
label: 'Tests',
|
|
83
|
-
description: 'A change confined to tests, test fixtures, or test helpers, including one that unblocks a build or a type check.',
|
|
84
|
-
breakingPolicy: 'forbidden',
|
|
85
|
-
},
|
|
86
|
-
{
|
|
87
|
-
tier: 'process',
|
|
88
|
-
key: 'tooling',
|
|
89
|
-
aliases: [],
|
|
90
|
-
emoji: 'โ๏ธ',
|
|
91
|
-
label: 'Tooling',
|
|
92
|
-
description: 'A change to the tools used to develop the project: build, lint, formatting, and release configuration, and development scripts.',
|
|
93
|
-
breakingPolicy: 'forbidden',
|
|
94
|
-
},
|
|
95
|
-
{
|
|
96
|
-
tier: 'process',
|
|
97
|
-
key: 'ci',
|
|
98
|
-
aliases: [],
|
|
99
|
-
emoji: '๐ท',
|
|
100
|
-
label: 'CI',
|
|
101
|
-
description: 'A change to continuous-integration workflows and their configuration.',
|
|
102
|
-
breakingPolicy: 'forbidden',
|
|
103
|
-
},
|
|
104
|
-
{
|
|
105
|
-
tier: 'process',
|
|
106
|
-
key: 'deps',
|
|
107
|
-
aliases: ['dep'],
|
|
108
|
-
emoji: '๐ฆ',
|
|
109
|
-
label: 'Dependencies',
|
|
110
|
-
description: 'A change that adds, removes, or upgrades a dependency, including its lockfile and version-catalog entries.',
|
|
111
|
-
breakingPolicy: 'forbidden',
|
|
112
|
-
},
|
|
113
|
-
{
|
|
114
|
-
tier: 'process',
|
|
115
|
-
key: 'ai',
|
|
116
|
-
aliases: [],
|
|
117
|
-
emoji: '๐ค',
|
|
118
|
-
label: 'Agentic support',
|
|
119
|
-
description: "A change to guidance on working in the repository itself, such as its `AGENTS.md` or a repo-local skill, or to the repository's agent configuration.",
|
|
120
|
-
breakingPolicy: 'forbidden',
|
|
121
|
-
},
|
|
122
|
-
{
|
|
123
|
-
tier: 'process',
|
|
124
|
-
key: 'docs',
|
|
125
|
-
aliases: ['doc'],
|
|
126
|
-
emoji: '๐',
|
|
127
|
-
label: 'Documentation',
|
|
128
|
-
description: 'A change to documentation for human readers, such as a README, a guide, or a code comment.',
|
|
129
|
-
breakingPolicy: 'forbidden',
|
|
130
|
-
},
|
|
131
|
-
{
|
|
132
|
-
tier: 'process',
|
|
133
|
-
key: 'fmt',
|
|
134
|
-
aliases: [],
|
|
135
|
-
emoji: '๐จ',
|
|
136
|
-
label: 'Formatting',
|
|
137
|
-
description: 'A change to formatting alone, such as whitespace or line wrapping, that leaves the content unchanged.',
|
|
138
|
-
breakingPolicy: 'forbidden',
|
|
139
|
-
excludedFromChangelog: true,
|
|
140
|
-
},
|
|
141
|
-
],
|
|
142
|
-
markers: {
|
|
143
|
-
breaking: { emoji: '๐จ', label: 'Breaking' },
|
|
144
|
-
},
|
|
145
|
-
};
|
package/schemas/label-map.json
DELETED
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
-
"title": "label-map",
|
|
4
|
-
"description": "Maps commit-prefix scopes and types to GitHub label names. Consumed by agent skills, CI tooling, and any script that needs to translate commit conventions into label operations.",
|
|
5
|
-
"type": "object",
|
|
6
|
-
"required": ["types", "scopes"],
|
|
7
|
-
"additionalProperties": false,
|
|
8
|
-
"properties": {
|
|
9
|
-
"$schema": {
|
|
10
|
-
"type": "string",
|
|
11
|
-
"description": "JSON Schema reference for editor support."
|
|
12
|
-
},
|
|
13
|
-
"types": {
|
|
14
|
-
"type": "object",
|
|
15
|
-
"description": "Maps commit-type prefix (e.g., `feat`) to GitHub label name (e.g., `feature`).",
|
|
16
|
-
"additionalProperties": { "type": "string" }
|
|
17
|
-
},
|
|
18
|
-
"scopes": {
|
|
19
|
-
"type": "object",
|
|
20
|
-
"description": "Maps commit-scope prefix (e.g., `audit`) to GitHub label name (e.g., `scope:audit`).",
|
|
21
|
-
"additionalProperties": { "type": "string" }
|
|
22
|
-
}
|
|
23
|
-
}
|
|
24
|
-
}
|