semantic-release 11.0.1 → 11.0.2
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 +16 -0
- package/lib/get-commits.js +3 -9
- package/lib/plugins/normalize.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -287,6 +287,8 @@ Being able to write code for just the most recent node versions greatly simplifi
|
|
|
287
287
|
|
|
288
288
|
For a special purpose tool like `semantic-release`, that's only meant to be used in controlled CI environments, we think it's okay to have such a high version requirement. As `semantic-release` handles package publishing we expect almost every project to have at least one build job running node 8 already – and that's all it takes. Even if that's not that case `semantic-release` can still be executed with the help of [npx](https://www.npmjs.com/package/npx) (`npx -p node@8 npm run semantic-release`).
|
|
289
289
|
|
|
290
|
+
Please see our [Node Support Policy](#node-support-policy) for our long-term promise for supporting Node.
|
|
291
|
+
|
|
290
292
|
## Badge
|
|
291
293
|
|
|
292
294
|
Use this in one of your projects? Include one of these badges in your README.md to let people know that your package is published using `semantic-release`.
|
|
@@ -309,6 +311,20 @@ Use this in one of your projects? Include one of these badges in your README.md
|
|
|
309
311
|
[](https://github.com/semantic-release/semantic-release)
|
|
310
312
|
```
|
|
311
313
|
|
|
314
|
+
## Node Support Policy
|
|
315
|
+
|
|
316
|
+
We only support [Long-Term Support](https://github.com/nodejs/Release) versions of Node starting with [Node 8.9.0 (LTS)](https://nodejs.org/en/blog/release/v8.9.0/).
|
|
317
|
+
|
|
318
|
+
We specifically limit our support to LTS versions of Node, not because this package won't work on other versions, but because we have a limited amount of time, and supporting LTS offers the greatest return on that investment.
|
|
319
|
+
|
|
320
|
+
It's possible this package will work correctly on newer versions of Node. It may even be possible to use this package on older versions of Node, though that's more unlikely as we'll make every effort to take advantage of features available in the oldest LTS version we support.
|
|
321
|
+
|
|
322
|
+
As each Node LTS version reaches its end-of-life we will remove that version from the node engines property of our package's package.json file. Removing a Node version is considered a breaking change and will entail the publishing of a new major version of this package. We will not accept any requests to support an end-of-life version of Node. Any merge requests or issues supporting an end-of-life version of Node will be closed.
|
|
323
|
+
|
|
324
|
+
We will accept code that allows this package to run on newer, non-LTS, versions of Node. Furthermore, we will attempt to ensure our own changes work on the latest version of Node. To help in that commitment, our continuous integration setup runs against all LTS versions of Node in addition the most recent Node release; called current.
|
|
325
|
+
|
|
326
|
+
JavaScript package managers should allow you to install this package with any version of Node, with, at most, a warning if your version of Node does not fall within the range specified by our node engines property. If you encounter issues installing this package, please report the issue to your package manager.
|
|
327
|
+
|
|
312
328
|
## License
|
|
313
329
|
|
|
314
330
|
MIT License
|
package/lib/get-commits.js
CHANGED
|
@@ -84,24 +84,18 @@ function noGitHeadMessage(branch, version) {
|
|
|
84
84
|
This means semantic-release can not extract the commits between now and then.
|
|
85
85
|
This is usually caused by releasing from outside the repository directory or with innaccessible git metadata.
|
|
86
86
|
|
|
87
|
-
You can recover from this error by creating a tag for the version "${
|
|
88
|
-
version
|
|
89
|
-
}" on the commit corresponding to this release:
|
|
87
|
+
You can recover from this error by creating a tag for the version "${version}" on the commit corresponding to this release:
|
|
90
88
|
$ git tag -f v${version} <commit sha1 corresponding to last release>
|
|
91
89
|
$ git push -f --tags origin ${branch}
|
|
92
90
|
`;
|
|
93
91
|
}
|
|
94
92
|
|
|
95
93
|
function notInHistoryMessage(gitHead, branch, version) {
|
|
96
|
-
return `The commit the last release of this package was derived from is not in the direct history of the "${
|
|
97
|
-
branch
|
|
98
|
-
}" branch.
|
|
94
|
+
return `The commit the last release of this package was derived from is not in the direct history of the "${branch}" branch.
|
|
99
95
|
This means semantic-release can not extract the commits between now and then.
|
|
100
96
|
This is usually caused by force pushing, releasing from an unrelated branch, or using an already existing package name.
|
|
101
97
|
|
|
102
|
-
You can recover from this error by restoring the commit "${gitHead}" or by creating a tag for the version "${
|
|
103
|
-
version
|
|
104
|
-
}" on the commit corresponding to this release:
|
|
98
|
+
You can recover from this error by restoring the commit "${gitHead}" or by creating a tag for the version "${version}" on the commit corresponding to this release:
|
|
105
99
|
$ git tag -f v${version || '<version>'} <commit sha1 corresponding to last release>
|
|
106
100
|
$ git push -f --tags origin ${branch}
|
|
107
101
|
`;
|
package/lib/plugins/normalize.js
CHANGED
|
@@ -8,7 +8,7 @@ module.exports = (pluginType, pluginConfig, logger, validator) => {
|
|
|
8
8
|
}
|
|
9
9
|
const {path, ...config} = isString(pluginConfig) || isFunction(pluginConfig) ? {path: pluginConfig} : pluginConfig;
|
|
10
10
|
if (!isFunction(pluginConfig)) {
|
|
11
|
-
logger.log('Load plugin %s', path);
|
|
11
|
+
logger.log('Load plugin %s from %s', pluginType, path);
|
|
12
12
|
}
|
|
13
13
|
const plugin = isFunction(path) ? path : importFrom.silent(__dirname, path) || importFrom(process.cwd(), path);
|
|
14
14
|
|
package/package.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"name":"semantic-release","description":"Automated semver compliant package publishing","version":"11.0.
|
|
1
|
+
{"name":"semantic-release","description":"Automated semver compliant package publishing","version":"11.0.2","author":"Stephan Bönnemann <stephan@boennemann.me> (http://boennemann.me)","bin":{"semantic-release":"bin/semantic-release.js"},"bugs":{"url":"https://github.com/semantic-release/semantic-release/issues"},"config":{"commitizen":{"path":"cz-conventional-changelog"}},"dependencies":{"@semantic-release/commit-analyzer":"^5.0.0","@semantic-release/condition-travis":"^7.0.0","@semantic-release/error":"^2.1.0","@semantic-release/github":"^2.0.0","@semantic-release/npm":"^2.0.0","@semantic-release/release-notes-generator":"^6.0.0","chalk":"^2.3.0","commander":"^2.11.0","cosmiconfig":"^3.1.0","debug":"^3.1.0","execa":"^0.8.0","get-stream":"^3.0.0","git-log-parser":"^1.2.0","import-from":"^2.1.0","lodash":"^4.0.0","marked":"^0.3.6","marked-terminal":"^2.0.0","p-reduce":"^1.0.0","read-pkg-up":"^3.0.0","semver":"^5.4.1"},"devDependencies":{"ava":"^0.24.0","codecov":"^3.0.0","commitizen":"^2.9.6","cz-conventional-changelog":"^2.0.0","dockerode":"^2.5.2","eslint-config-prettier":"^2.5.0","eslint-plugin-prettier":"^2.3.0","file-url":"^2.0.2","fs-extra":"^4.0.2","got":"^8.0.0","js-yaml":"^3.10.0","mockserver-client":"^5.1.1","nock":"^9.0.2","nyc":"^11.2.1","p-retry":"^1.0.0","prettier":"~1.9.0","proxyquire":"^1.8.0","sinon":"^4.0.0","tempy":"^0.2.1","xo":"^0.18.2"},"engines":{"node":">=4","npm":">=2"},"files":["bin","lib","index.js","cli.js"],"homepage":"https://github.com/semantic-release/semantic-release#readme","keywords":["author","automation","changelog","module","package","publish","release","semver","version"],"license":"MIT","main":"index.js","nyc":{"include":["lib/**/*.js","index.js","cli.js"],"reporter":["json","text","html"],"all":true},"prettier":{"printWidth":120,"singleQuote":true,"bracketSpacing":false,"trailingComma":"es5"},"publishConfig":{"tag":"next"},"release":{"branch":"caribou"},"repository":{"type":"git","url":"git+https://github.com/semantic-release/semantic-release.git"},"scripts":{"cm":"git-cz","codecov":"codecov -f coverage/coverage-final.json","lint":"xo","pretest":"npm run lint","semantic-release":"./bin/semantic-release.js","test":"nyc ava -v"},"xo":{"extends":["prettier"],"plugins":["prettier"],"rules":{"prettier/prettier":2}}}
|