semantic-release 25.0.5 → 25.0.6
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/README.md +36 -30
- package/bin/semantic-release.js +1 -1
- package/lib/definitions/errors.js +38 -33
- package/lib/hide-sensitive.js +14 -1
- package/package.json +20 -15
- package/docs/README.md +0 -7
- package/docs/developer-guide/README.md +0 -5
- package/docs/developer-guide/js-api.md +0 -294
- package/docs/developer-guide/plugin.md +0 -284
- package/docs/developer-guide/shareable-configuration.md +0 -1
- package/docs/extending/README.md +0 -4
- package/docs/extending/plugins-list.md +0 -233
- package/docs/extending/shareable-configurations-list.md +0 -22
- package/docs/recipes/ci-configurations/README.md +0 -7
- package/docs/recipes/ci-configurations/circleci-workflows.md +0 -49
- package/docs/recipes/ci-configurations/github-actions.md +0 -136
- package/docs/recipes/ci-configurations/gitlab-ci.md +0 -98
- package/docs/recipes/ci-configurations/jenkins-ci.md +0 -61
- package/docs/recipes/ci-configurations/travis.md +0 -97
- package/docs/recipes/git-hosted-services/README.md +0 -3
- package/docs/recipes/git-hosted-services/git-auth-ssh-keys.md +0 -166
- package/docs/recipes/release-workflow/README.md +0 -5
- package/docs/recipes/release-workflow/distribution-channels.md +0 -117
- package/docs/recipes/release-workflow/maintenance-releases.md +0 -157
- package/docs/recipes/release-workflow/pre-releases.md +0 -197
- package/docs/support/FAQ.md +0 -253
- package/docs/support/README.md +0 -7
- package/docs/support/git-version.md +0 -4
- package/docs/support/node-support-policy.md +0 -21
- package/docs/support/node-version.md +0 -38
- package/docs/support/resources.md +0 -22
- package/docs/support/troubleshooting.md +0 -70
- package/docs/usage/README.md +0 -9
- package/docs/usage/ci-configuration.md +0 -50
- package/docs/usage/configuration.md +0 -206
- package/docs/usage/getting-started.md +0 -8
- package/docs/usage/installation.md +0 -51
- package/docs/usage/plugins.md +0 -105
- package/docs/usage/shareable-configurations.md +0 -7
- package/docs/usage/workflow-configuration.md +0 -199
package/README.md
CHANGED
|
@@ -40,10 +40,10 @@ This removes the immediate connection between human emotions and version numbers
|
|
|
40
40
|
- Notify maintainers and users of new releases
|
|
41
41
|
- Use formalized commit message convention to document changes in the codebase
|
|
42
42
|
- Publish on different distribution channels (such as [npm dist-tags](https://docs.npmjs.com/cli/dist-tag)) based on git merges
|
|
43
|
-
- Integrate with your [continuous integration workflow](
|
|
43
|
+
- Integrate with your [continuous integration workflow](https://semantic-release.org/recipes/ci-configurations/#ci-configurations)
|
|
44
44
|
- Avoid potential errors associated with manual releases
|
|
45
|
-
- Support any [package managers and languages](
|
|
46
|
-
- Simple and reusable configuration via [shareable configurations](
|
|
45
|
+
- Support any [package managers and languages](https://semantic-release.org/recipes/release-workflow/#package-managers-and-languages) via [plugins](https://semantic-release.org/foundation/plugins/)
|
|
46
|
+
- Simple and reusable configuration via [shareable configurations](https://semantic-release.org/foundation/shareable-configurations/)
|
|
47
47
|
- Support for [npm package provenance](https://github.com/semantic-release/npm#npm-provenance) that promotes increased supply-chain security via signed attestations on GitHub Actions
|
|
48
48
|
|
|
49
49
|
## How does it work?
|
|
@@ -54,7 +54,7 @@ This removes the immediate connection between human emotions and version numbers
|
|
|
54
54
|
Following formalized conventions for commit messages, **semantic-release** automatically determines the next [semantic version](https://semver.org) number, generates a changelog and publishes the release.
|
|
55
55
|
|
|
56
56
|
By default, **semantic-release** uses [Angular Commit Message Conventions](https://github.com/angular/angular/blob/main/contributing-docs/commit-message-guidelines.md).
|
|
57
|
-
The commit message format can be changed with the [`preset` or `config` options](
|
|
57
|
+
The commit message format can be changed with the [`preset` or `config` options](https://semantic-release.org/usage/configuration/#options) of the [@semantic-release/commit-analyzer](https://github.com/semantic-release/commit-analyzer#options) and [@semantic-release/release-notes-generator](https://github.com/semantic-release/release-notes-generator#options) plugins.
|
|
58
58
|
|
|
59
59
|
Tools such as [commitizen](https://github.com/commitizen/cz-cli) or [commitlint](https://github.com/conventional-changelog/commitlint) can be used to help contributors and enforce valid commit messages.
|
|
60
60
|
|
|
@@ -78,9 +78,9 @@ For each new commit added to one of the release branches (for example: `master`,
|
|
|
78
78
|
**semantic-release** offers various ways to control the timing, the content and the audience of published releases.
|
|
79
79
|
See example workflows in the following recipes:
|
|
80
80
|
|
|
81
|
-
- [Using distribution channels](
|
|
82
|
-
- [Maintenance releases](
|
|
83
|
-
- [Pre-releases](
|
|
81
|
+
- [Using distribution channels](https://semantic-release.org/recipes/release-workflow/distribution-channels/#publishing-on-distribution-channels)
|
|
82
|
+
- [Maintenance releases](https://semantic-release.org/recipes/release-workflow/maintenance-releases/#publishing-maintenance-releases)
|
|
83
|
+
- [Pre-releases](https://semantic-release.org/recipes/release-workflow/pre-releases/#publishing-pre-releases)
|
|
84
84
|
|
|
85
85
|
### Release steps
|
|
86
86
|
|
|
@@ -103,37 +103,43 @@ After running the tests, the command `semantic-release` will execute the followi
|
|
|
103
103
|
In order to use **semantic-release** you need:
|
|
104
104
|
|
|
105
105
|
- To host your code in a [Git repository](https://git-scm.com)
|
|
106
|
-
- Use a Continuous Integration service that allows you to [securely set up credentials](
|
|
107
|
-
- A Git CLI version that meets [our version requirement](
|
|
108
|
-
- A [Node.js](https://nodejs.org) version that meets [our version requirement](
|
|
106
|
+
- Use a Continuous Integration service that allows you to [securely set up credentials](https://semantic-release.org/usage/ci-configuration/#authentication)
|
|
107
|
+
- A Git CLI version that meets [our version requirement](https://semantic-release.org/support/git-version/) installed in your Continuous Integration environment
|
|
108
|
+
- A [Node.js](https://nodejs.org) version that meets [our version requirement](https://semantic-release.org/support/node-version/) installed in your Continuous Integration environment
|
|
109
109
|
|
|
110
110
|
## Documentation
|
|
111
111
|
|
|
112
112
|
- Usage
|
|
113
|
-
- [Getting started](
|
|
114
|
-
- [
|
|
115
|
-
- [CI Configuration](
|
|
116
|
-
- [
|
|
117
|
-
|
|
118
|
-
- [
|
|
119
|
-
- [
|
|
113
|
+
- [Getting started](https://semantic-release.org/usage/getting-started/)
|
|
114
|
+
- [Configuration](https://semantic-release.org/usage/configuration/)
|
|
115
|
+
- [CI Configuration](https://semantic-release.org/usage/ci-configuration/)
|
|
116
|
+
- [Running semantic-release](https://semantic-release.org/usage/running/)
|
|
117
|
+
- Foundations
|
|
118
|
+
- [How it works](https://semantic-release.org/foundation/how-it-works/)
|
|
119
|
+
- [Release Steps](https://semantic-release.org/foundation/release-steps/)
|
|
120
|
+
- [Considerations](https://semantic-release.org/foundation/considerations/)
|
|
121
|
+
- [Supported Branching Models](https://semantic-release.org/foundation/supported-branching/)
|
|
122
|
+
- [Release Workflow configuration](https://semantic-release.org/foundation/workflow-configuration/)
|
|
123
|
+
- [Plugins](https://semantic-release.org/foundation/plugins/)
|
|
124
|
+
- [Shareable configurations](https://semantic-release.org/foundation/shareable-configurations/)
|
|
120
125
|
- Extending
|
|
121
|
-
- [Plugins](
|
|
122
|
-
- [Shareable configuration](
|
|
126
|
+
- [Plugins](https://semantic-release.org/extending/plugins-list/)
|
|
127
|
+
- [Shareable configuration](https://semantic-release.org/extending/shareable-configurations-list/)
|
|
123
128
|
- Recipes
|
|
124
|
-
- [CI configurations](
|
|
125
|
-
- [Git hosted services](
|
|
126
|
-
- [Release workflow](
|
|
129
|
+
- [CI configurations](https://semantic-release.org/recipes/ci-configurations/)
|
|
130
|
+
- [Git hosted services](https://semantic-release.org/recipes/git-hosted-services/)
|
|
131
|
+
- [Release workflow](https://semantic-release.org/recipes/release-workflow/)
|
|
127
132
|
- Developer guide
|
|
128
|
-
- [JavaScript API](
|
|
129
|
-
- [Plugins development](
|
|
130
|
-
- [Shareable configuration development](
|
|
133
|
+
- [JavaScript API](https://semantic-release.org/developer-guide/js-api/)
|
|
134
|
+
- [Plugins development](https://semantic-release.org/developer-guide/plugin/)
|
|
135
|
+
- [Shareable configuration development](https://semantic-release.org/developer-guide/shareable-configuration/)
|
|
131
136
|
- Support
|
|
132
|
-
- [Resources](
|
|
133
|
-
- [Frequently Asked Questions](
|
|
134
|
-
- [Troubleshooting](
|
|
135
|
-
- [Node version requirement](
|
|
136
|
-
- [Node Support Policy](
|
|
137
|
+
- [Resources](https://semantic-release.org/support/resources/)
|
|
138
|
+
- [Frequently Asked Questions](https://semantic-release.org/support/faq/)
|
|
139
|
+
- [Troubleshooting](https://semantic-release.org/support/troubleshooting/)
|
|
140
|
+
- [Node version requirement](https://semantic-release.org/support/node-version/)
|
|
141
|
+
- [Node Support Policy](https://semantic-release.org/support/node-support-policy/)
|
|
142
|
+
- [Git Version requirement](https://semantic-release.org/support/git-version/)
|
|
137
143
|
|
|
138
144
|
## Get help
|
|
139
145
|
|
package/bin/semantic-release.js
CHANGED
|
@@ -18,7 +18,7 @@ if (!satisfies(process.version, engines.node)) {
|
|
|
18
18
|
console.error(
|
|
19
19
|
`[semantic-release]: node version ${engines.node} is required. Found ${process.version}.
|
|
20
20
|
|
|
21
|
-
See https://
|
|
21
|
+
See https://semantic-release.org/support/node-version/ for more details and solutions.`
|
|
22
22
|
);
|
|
23
23
|
process.exit(1);
|
|
24
24
|
}
|
|
@@ -1,15 +1,20 @@
|
|
|
1
1
|
import { inspect } from "node:util";
|
|
2
|
-
import { createRequire } from "node:module";
|
|
3
2
|
import { isString, toLower, trim } from "lodash-es";
|
|
4
3
|
import { RELEASE_TYPE } from "./constants.js";
|
|
5
4
|
|
|
6
|
-
|
|
7
|
-
|
|
5
|
+
import pkg from "../../package.json" with { type: "json" };
|
|
6
|
+
|
|
7
|
+
const DOCS_URL = "https://semantic-release.org";
|
|
8
8
|
|
|
9
|
-
const [homepage] = pkg.homepage.split("#");
|
|
10
9
|
const stringify = (object) =>
|
|
11
10
|
isString(object) ? object : inspect(object, { breakLength: Infinity, depth: 2, maxArrayLength: 5 });
|
|
12
|
-
|
|
11
|
+
|
|
12
|
+
const linkify = (file) => {
|
|
13
|
+
const [path, hash] = file.split("#");
|
|
14
|
+
|
|
15
|
+
return `${DOCS_URL}/${path.replace(/\.md$/u, "")}${hash ? `#${hash}` : ""}`;
|
|
16
|
+
};
|
|
17
|
+
|
|
13
18
|
const wordsList = (words) =>
|
|
14
19
|
`${words.slice(0, -1).join(", ")}${words.length > 1 ? ` or ${words[words.length - 1]}` : trim(words[0])}`;
|
|
15
20
|
|
|
@@ -28,11 +33,11 @@ export function ENOREPOURL() {
|
|
|
28
33
|
return {
|
|
29
34
|
message: "The `repositoryUrl` option is required.",
|
|
30
35
|
details: `The [repositoryUrl option](${linkify(
|
|
31
|
-
"
|
|
36
|
+
"usage/configuration#repositoryurl"
|
|
32
37
|
)}) cannot be determined from the semantic-release configuration, the \`package.json\` nor the [git origin url](https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes).
|
|
33
38
|
|
|
34
|
-
Please make sure to add the \`repositoryUrl\` to the [semantic-release configuration]
|
|
35
|
-
"
|
|
39
|
+
Please make sure to add the \`repositoryUrl\` to the [semantic-release configuration](${linkify(
|
|
40
|
+
"usage/configuration#repositoryurl"
|
|
36
41
|
)}).`,
|
|
37
42
|
};
|
|
38
43
|
}
|
|
@@ -43,10 +48,10 @@ export function EGITNOPERMISSION({ options: { repositoryUrl }, branch: { name }
|
|
|
43
48
|
details: `**semantic-release** cannot push the version tag to the branch \`${name}\` on the remote Git repository with URL \`${repositoryUrl}\`.
|
|
44
49
|
|
|
45
50
|
This can be caused by:
|
|
46
|
-
- a misconfiguration of the [repositoryUrl](${linkify("
|
|
51
|
+
- a misconfiguration of the [repositoryUrl](${linkify("usage/configuration#repositoryurl")}) option
|
|
47
52
|
- the repository being unavailable
|
|
48
53
|
- or missing push permission for the user configured via the [Git credentials on your CI environment](${linkify(
|
|
49
|
-
"
|
|
54
|
+
"usage/ci-configuration#authentication"
|
|
50
55
|
)})`,
|
|
51
56
|
};
|
|
52
57
|
}
|
|
@@ -55,7 +60,7 @@ export function EINVALIDTAGFORMAT({ options: { tagFormat } }) {
|
|
|
55
60
|
return {
|
|
56
61
|
message: "Invalid `tagFormat` option.",
|
|
57
62
|
details: `The [tagFormat](${linkify(
|
|
58
|
-
"
|
|
63
|
+
"usage/configuration#tagformat"
|
|
59
64
|
)}) must compile to a [valid Git reference](https://git-scm.com/docs/git-check-ref-format#_description).
|
|
60
65
|
|
|
61
66
|
Your configuration for the \`tagFormat\` option is \`${stringify(tagFormat)}\`.`,
|
|
@@ -66,7 +71,7 @@ export function ETAGNOVERSION({ options: { tagFormat } }) {
|
|
|
66
71
|
return {
|
|
67
72
|
message: "Invalid `tagFormat` option.",
|
|
68
73
|
details: `The [tagFormat](${linkify(
|
|
69
|
-
"
|
|
74
|
+
"usage/configuration#tagformat"
|
|
70
75
|
)}) option must contain the variable \`version\` exactly once.
|
|
71
76
|
|
|
72
77
|
Your configuration for the \`tagFormat\` option is \`${stringify(tagFormat)}\`.`,
|
|
@@ -76,7 +81,7 @@ Your configuration for the \`tagFormat\` option is \`${stringify(tagFormat)}\`.`
|
|
|
76
81
|
export function EPLUGINCONF({ type, required, pluginConf }) {
|
|
77
82
|
return {
|
|
78
83
|
message: `The \`${type}\` plugin configuration is invalid.`,
|
|
79
|
-
details: `The [${type} plugin configuration](${linkify(`
|
|
84
|
+
details: `The [${type} plugin configuration](${linkify(`foundation/plugins#${toLower(type)}-plugin`)}) ${
|
|
80
85
|
required ? "is required and " : ""
|
|
81
86
|
} must be a single or an array of plugins definition. A plugin definition is an npm module name, optionally wrapped in an array with an object.
|
|
82
87
|
|
|
@@ -88,7 +93,7 @@ export function EPLUGINSCONF({ plugin }) {
|
|
|
88
93
|
return {
|
|
89
94
|
message: "The `plugins` configuration is invalid.",
|
|
90
95
|
details: `The [plugins](${linkify(
|
|
91
|
-
"
|
|
96
|
+
"usage/configuration#plugins"
|
|
92
97
|
)}) option must be an array of plugin definitions. A plugin definition is an npm module name, optionally wrapped in an array with an object.
|
|
93
98
|
|
|
94
99
|
The invalid configuration is \`${stringify(plugin)}\`.`,
|
|
@@ -103,7 +108,7 @@ export function EPLUGIN({ pluginName, type }) {
|
|
|
103
108
|
The plugin \`${pluginName}\` doesn't have the property \`${type}\` and cannot be used for the \`${type}\` step.
|
|
104
109
|
|
|
105
110
|
Please refer to the \`${pluginName}\` and [semantic-release plugins configuration](${linkify(
|
|
106
|
-
"
|
|
111
|
+
"foundation/plugins/#plugin-options-configuration"
|
|
107
112
|
)}) documentation for more details.`,
|
|
108
113
|
};
|
|
109
114
|
}
|
|
@@ -121,8 +126,8 @@ We recommend to report the issue to the \`${pluginName}\` authors, providing the
|
|
|
121
126
|
- The **semantic-release** version: \`${pkg.version}\`
|
|
122
127
|
- The **semantic-release** logs from your CI job
|
|
123
128
|
- The value returned by the plugin: \`${stringify(result)}\`
|
|
124
|
-
- A link to the **semantic-release** plugin developer guide: [${linkify("
|
|
125
|
-
"
|
|
129
|
+
- A link to the **semantic-release** plugin developer guide: [${linkify("developer-guide/plugin")}](${linkify(
|
|
130
|
+
"developer-guide/plugin"
|
|
126
131
|
)})`,
|
|
127
132
|
};
|
|
128
133
|
}
|
|
@@ -138,8 +143,8 @@ We recommend to report the issue to the \`${pluginName}\` authors, providing the
|
|
|
138
143
|
- The **semantic-release** version: \`${pkg.version}\`
|
|
139
144
|
- The **semantic-release** logs from your CI job
|
|
140
145
|
- The value returned by the plugin: \`${stringify(result)}\`
|
|
141
|
-
- A link to the **semantic-release** plugin developer guide: [${linkify("
|
|
142
|
-
"
|
|
146
|
+
- A link to the **semantic-release** plugin developer guide: [${linkify("developer-guide/plugin")}](${linkify(
|
|
147
|
+
"developer-guide/plugin"
|
|
143
148
|
)})`,
|
|
144
149
|
};
|
|
145
150
|
}
|
|
@@ -155,8 +160,8 @@ We recommend to report the issue to the \`${pluginName}\` authors, providing the
|
|
|
155
160
|
- The **semantic-release** version: \`${pkg.version}\`
|
|
156
161
|
- The **semantic-release** logs from your CI job
|
|
157
162
|
- The value returned by the plugin: \`${stringify(result)}\`
|
|
158
|
-
- A link to the **semantic-release** plugin developer guide: [${linkify("
|
|
159
|
-
"
|
|
163
|
+
- A link to the **semantic-release** plugin developer guide: [${linkify("developer-guide/plugin")}](${linkify(
|
|
164
|
+
"developer-guide/plugin"
|
|
160
165
|
)})`,
|
|
161
166
|
};
|
|
162
167
|
}
|
|
@@ -172,8 +177,8 @@ We recommend to report the issue to the \`${pluginName}\` authors, providing the
|
|
|
172
177
|
- The **semantic-release** version: \`${pkg.version}\`
|
|
173
178
|
- The **semantic-release** logs from your CI job
|
|
174
179
|
- The value returned by the plugin: \`${stringify(result)}\`
|
|
175
|
-
- A link to the **semantic-release** plugin developer guide: [${linkify("
|
|
176
|
-
"
|
|
180
|
+
- A link to the **semantic-release** plugin developer guide: [${linkify("developer-guide/plugin")}](${linkify(
|
|
181
|
+
"developer-guide/plugin"
|
|
177
182
|
)})`,
|
|
178
183
|
};
|
|
179
184
|
}
|
|
@@ -182,7 +187,7 @@ export function EINVALIDBRANCH({ branch }) {
|
|
|
182
187
|
return {
|
|
183
188
|
message: "A branch is invalid in the `branches` configuration.",
|
|
184
189
|
details: `Each branch in the [branches configuration](${linkify(
|
|
185
|
-
"
|
|
190
|
+
"usage/configuration#branches"
|
|
186
191
|
)}) must be either a string, a regexp or an object with a \`name\` property.
|
|
187
192
|
|
|
188
193
|
Your configuration for the problematic branch is \`${stringify(branch)}\`.`,
|
|
@@ -193,7 +198,7 @@ export function EINVALIDBRANCHNAME({ branch }) {
|
|
|
193
198
|
return {
|
|
194
199
|
message: "A branch name is invalid in the `branches` configuration.",
|
|
195
200
|
details: `Each branch in the [branches configuration](${linkify(
|
|
196
|
-
"
|
|
201
|
+
"usage/configuration#branches"
|
|
197
202
|
)}) must be a [valid Git reference](https://git-scm.com/docs/git-check-ref-format#_description).
|
|
198
203
|
|
|
199
204
|
Your configuration for the problematic branch is \`${stringify(branch)}\`.`,
|
|
@@ -204,7 +209,7 @@ export function EDUPLICATEBRANCHES({ duplicates }) {
|
|
|
204
209
|
return {
|
|
205
210
|
message: "The `branches` configuration has duplicate branches.",
|
|
206
211
|
details: `Each branch in the [branches configuration](${linkify(
|
|
207
|
-
"
|
|
212
|
+
"usage/configuration#branches"
|
|
208
213
|
)}) must havea unique name.
|
|
209
214
|
|
|
210
215
|
Your configuration contains duplicates for the following branch names: \`${stringify(duplicates)}\`.`,
|
|
@@ -215,7 +220,7 @@ export function EMAINTENANCEBRANCH({ branch }) {
|
|
|
215
220
|
return {
|
|
216
221
|
message: "A maintenance branch is invalid in the `branches` configuration.",
|
|
217
222
|
details: `Each maintenance branch in the [branches configuration](${linkify(
|
|
218
|
-
"
|
|
223
|
+
"usage/configuration#branches"
|
|
219
224
|
)}) must have a \`range\` property formatted like \`N.x\`, \`N.x.x\` or \`N.N.x\` (\`N\` is a number).
|
|
220
225
|
|
|
221
226
|
Your configuration for the problematic branch is \`${stringify(branch)}\`.`,
|
|
@@ -226,7 +231,7 @@ export function EMAINTENANCEBRANCHES({ branches }) {
|
|
|
226
231
|
return {
|
|
227
232
|
message: "The maintenance branches are invalid in the `branches` configuration.",
|
|
228
233
|
details: `Each maintenance branch in the [branches configuration](${linkify(
|
|
229
|
-
"
|
|
234
|
+
"usage/configuration#branches"
|
|
230
235
|
)}) must have a unique \`range\` property and must exist on the remote repository.
|
|
231
236
|
|
|
232
237
|
Your configuration for the problematic branches is \`${stringify(branches)}\`.`,
|
|
@@ -237,7 +242,7 @@ export function ERELEASEBRANCHES({ branches }) {
|
|
|
237
242
|
return {
|
|
238
243
|
message: "The release branches are invalid in the `branches` configuration.",
|
|
239
244
|
details: `A minimum of 1 and a maximum of 3 release branches are required in the [branches configuration](${linkify(
|
|
240
|
-
"
|
|
245
|
+
"usage/configuration#branches"
|
|
241
246
|
)}). These branches must exist on the remote repository.
|
|
242
247
|
|
|
243
248
|
This may occur if your repository does not have a release branch, such as \`master\` or \`main\`.
|
|
@@ -250,7 +255,7 @@ export function EPRERELEASEBRANCH({ branch }) {
|
|
|
250
255
|
return {
|
|
251
256
|
message: "A pre-release branch configuration is invalid in the `branches` configuration.",
|
|
252
257
|
details: `Each pre-release branch in the [branches configuration](${linkify(
|
|
253
|
-
"
|
|
258
|
+
"usage/configuration#branches"
|
|
254
259
|
)}) must have a \`prerelease\` property valid per the [Semantic Versioning Specification](https://semver.org/#spec-item-9). If the \`prerelease\` property is set to \`true\`, then the \`name\` property is used instead. Additionally, each pre-release branch must exist on the remote repository.
|
|
255
260
|
|
|
256
261
|
Your configuration for the problematic branch is \`${stringify(branch)}\`.`,
|
|
@@ -261,7 +266,7 @@ export function EPRERELEASEBRANCHES({ branches }) {
|
|
|
261
266
|
return {
|
|
262
267
|
message: "The pre-release branches are invalid in the `branches` configuration.",
|
|
263
268
|
details: `Each pre-release branch in the [branches configuration](${linkify(
|
|
264
|
-
"
|
|
269
|
+
"usage/configuration#branches"
|
|
265
270
|
)}) must have a unique \`prerelease\` property. If the \`prerelease\` property is set to \`true\`, then the \`name\` property is used instead.
|
|
266
271
|
|
|
267
272
|
Your configuration for the problematic branches is \`${stringify(branches)}\`.`,
|
|
@@ -282,7 +287,7 @@ ${
|
|
|
282
287
|
|
|
283
288
|
A valid branch could be ${wordsList(validBranches.map(({ name }) => `\`${name}\``))}.
|
|
284
289
|
|
|
285
|
-
See the [workflow configuration documentation](${linkify("
|
|
290
|
+
See the [workflow configuration documentation](${linkify("foundation/workflow-configuration")}) for more details.`,
|
|
286
291
|
};
|
|
287
292
|
}
|
|
288
293
|
|
|
@@ -293,6 +298,6 @@ export function EINVALIDMAINTENANCEMERGE({ nextRelease: { channel, gitTag, versi
|
|
|
293
298
|
|
|
294
299
|
The branch \`${name}\` head should be [reset](https://git-scm.com/docs/git-reset) to a previous commit so the commit with tag \`${gitTag}\` is removed from the branch history.
|
|
295
300
|
|
|
296
|
-
See the [workflow configuration documentation](${linkify("
|
|
301
|
+
See the [workflow configuration documentation](${linkify("foundation/workflow-configuration")}) for more details.`,
|
|
297
302
|
};
|
|
298
303
|
}
|
package/lib/hide-sensitive.js
CHANGED
|
@@ -12,7 +12,20 @@ export default (env) => {
|
|
|
12
12
|
});
|
|
13
13
|
|
|
14
14
|
const regexp = new RegExp(
|
|
15
|
-
toReplace
|
|
15
|
+
toReplace
|
|
16
|
+
.flatMap((envVar) => {
|
|
17
|
+
const value = env[envVar];
|
|
18
|
+
const forms = new Set([
|
|
19
|
+
value,
|
|
20
|
+
encodeURI(value),
|
|
21
|
+
encodeURIComponent(value),
|
|
22
|
+
// The form emitted by `url.format()`, which `get-git-auth-url.js` uses to embed credentials
|
|
23
|
+
// in the repository URL: like `encodeURIComponent()`, but `:` separators are kept as is
|
|
24
|
+
value.split(":").map(encodeURIComponent).join(":"),
|
|
25
|
+
]);
|
|
26
|
+
return [...forms].map(escapeRegExp);
|
|
27
|
+
})
|
|
28
|
+
.join("|"),
|
|
16
29
|
"g"
|
|
17
30
|
);
|
|
18
31
|
return (output) =>
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "semantic-release",
|
|
3
3
|
"description": "Automated semver compliant package publishing",
|
|
4
|
-
"version": "25.0.
|
|
4
|
+
"version": "25.0.6",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"author": "Stephan Bönnemann <stephan@boennemann.me> (http://boennemann.me)",
|
|
7
7
|
"ava": {
|
|
@@ -57,28 +57,28 @@
|
|
|
57
57
|
"yargs": "^18.0.0"
|
|
58
58
|
},
|
|
59
59
|
"devDependencies": {
|
|
60
|
-
"@types/node": "24.
|
|
60
|
+
"@types/node": "24.13.2",
|
|
61
61
|
"@types/signale": "1.4.7",
|
|
62
62
|
"ava": "8.0.1",
|
|
63
63
|
"c8": "11.0.0",
|
|
64
64
|
"clear-module": "4.1.3",
|
|
65
65
|
"cz-conventional-changelog": "3.3.0",
|
|
66
|
-
"dockerode": "5.0.0",
|
|
67
66
|
"file-url": "4.0.0",
|
|
68
|
-
"fs-extra": "11.3.
|
|
69
|
-
"got": "15.0
|
|
70
|
-
"js-yaml": "4.
|
|
67
|
+
"fs-extra": "11.3.6",
|
|
68
|
+
"got": "15.1.0",
|
|
69
|
+
"js-yaml": "4.3.0",
|
|
71
70
|
"lockfile-lint": "5.0.0",
|
|
72
|
-
"ls-engines": "0.10.
|
|
73
|
-
"mockserver-client": "
|
|
74
|
-
"nock": "14.0.
|
|
75
|
-
"npm-run-all2": "9.0.
|
|
71
|
+
"ls-engines": "0.10.1",
|
|
72
|
+
"mockserver-client": "7.4.0",
|
|
73
|
+
"nock": "14.0.16",
|
|
74
|
+
"npm-run-all2": "9.0.2",
|
|
76
75
|
"p-retry": "8.0.0",
|
|
77
|
-
"prettier": "3.8.
|
|
76
|
+
"prettier": "3.8.5",
|
|
78
77
|
"publint": "0.3.21",
|
|
79
78
|
"sinon": "22.0.0",
|
|
80
79
|
"stream-buffers": "3.0.3",
|
|
81
80
|
"tempy": "3.2.0",
|
|
81
|
+
"testcontainers": "12.0.4",
|
|
82
82
|
"testdouble": "3.20.2"
|
|
83
83
|
},
|
|
84
84
|
"engines": {
|
|
@@ -146,8 +146,8 @@
|
|
|
146
146
|
}
|
|
147
147
|
},
|
|
148
148
|
"scripts": {
|
|
149
|
-
"lint:prettier": "prettier --check \"*.{js,json,md}\" \".github/**/*.{md,yml}\" \"
|
|
150
|
-
"lint:prettier:fix": "prettier --write \"*.{js,json,md}\" \".github/**/*.{md,yml}\" \"
|
|
149
|
+
"lint:prettier": "prettier --check \"*.{js,json,md}\" \".github/**/*.{md,yml}\" \"{bin,lib,test}/**/*.js\"",
|
|
150
|
+
"lint:prettier:fix": "prettier --write \"*.{js,json,md}\" \".github/**/*.{md,yml}\" \"{bin,lib,test}/**/*.js\"",
|
|
151
151
|
"lint:lockfile": "lockfile-lint",
|
|
152
152
|
"lint:engines": "ls-engines",
|
|
153
153
|
"lint:publish": "publint --strict",
|
|
@@ -160,7 +160,12 @@
|
|
|
160
160
|
"renovate": {
|
|
161
161
|
"extends": [
|
|
162
162
|
"github>semantic-release/.github:renovate-config"
|
|
163
|
-
]
|
|
163
|
+
],
|
|
164
|
+
"docker-compose": {
|
|
165
|
+
"managerFilePatterns": [
|
|
166
|
+
"/(^|/)e2e\\.compose\\.ya?ml$/"
|
|
167
|
+
]
|
|
168
|
+
}
|
|
164
169
|
},
|
|
165
|
-
"packageManager": "npm@11.
|
|
170
|
+
"packageManager": "npm@11.18.0+sha512.4faecce0be70366d1c67b1012c4adc1246354a6cc45bf589f92003073b05518d547403df1475c542d67a4845e22b4fafcd7cac0af02c7a96cc6814f09eb003fb"
|
|
166
171
|
}
|
package/docs/README.md
DELETED
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
# semantic-release documentation
|
|
2
|
-
|
|
3
|
-
- [Usage](usage/README.md) - **semantic-release** installation and configuration
|
|
4
|
-
- [Extending](extending/README.md) - Extending **semantic-release** with plugins and shareable configurations
|
|
5
|
-
- [Recipes](recipes/release-workflow/README.md) - Community written recipes for common **semantic-release** use-cases
|
|
6
|
-
- [Developer Guide](developer-guide/README.md) - The essentials of writing a **semantic-release** plugin or shareable configurations
|
|
7
|
-
- [Support](support/README.md) - FAQ and troubleshooting
|