Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
0862480cf0 | ||
|
|
45eee4acdd | ||
|
|
2d3a5e53e9 | ||
|
|
4abda31f83 | ||
|
|
3602716c0b | ||
|
|
d4f68a5680 | ||
|
|
4454d57e02 | ||
|
|
9137f8537b | ||
|
|
7615fdc9bc | ||
|
|
2b6378f26f | ||
|
|
24a8052038 | ||
|
|
0ab0426075 | ||
|
|
f9d9144e3d | ||
|
|
11cef46c48 |
@@ -1,5 +1,3 @@
|
|||||||
const {pickBy, isUndefined} = require('lodash');
|
|
||||||
|
|
||||||
const stringList = {
|
const stringList = {
|
||||||
type: 'string',
|
type: 'string',
|
||||||
array: true,
|
array: true,
|
||||||
@@ -13,6 +11,7 @@ module.exports = async () => {
|
|||||||
const cli = require('yargs')
|
const cli = require('yargs')
|
||||||
.command('$0', 'Run automated package publishing', yargs => {
|
.command('$0', 'Run automated package publishing', yargs => {
|
||||||
yargs.demandCommand(0, 0).usage(`Run automated package publishing
|
yargs.demandCommand(0, 0).usage(`Run automated package publishing
|
||||||
|
|
||||||
Usage:
|
Usage:
|
||||||
semantic-release [options] [plugins]`);
|
semantic-release [options] [plugins]`);
|
||||||
})
|
})
|
||||||
@@ -20,7 +19,7 @@ Usage:
|
|||||||
.option('r', {alias: 'repository-url', describe: 'Git repository URL', type: 'string', group: 'Options'})
|
.option('r', {alias: 'repository-url', describe: 'Git repository URL', type: 'string', group: 'Options'})
|
||||||
.option('t', {alias: 'tag-format', describe: 'Git tag format', type: 'string', group: 'Options'})
|
.option('t', {alias: 'tag-format', describe: 'Git tag format', type: 'string', group: 'Options'})
|
||||||
.option('e', {alias: 'extends', describe: 'Shareable configurations', ...stringList, group: 'Options'})
|
.option('e', {alias: 'extends', describe: 'Shareable configurations', ...stringList, group: 'Options'})
|
||||||
.option('ci', {describe: 'Toggle CI verifications', default: undefined, type: 'boolean', group: 'Options'})
|
.option('ci', {describe: 'Toggle CI verifications', type: 'boolean', group: 'Options'})
|
||||||
.option('verify-conditions', {...stringList, group: 'Plugins'})
|
.option('verify-conditions', {...stringList, group: 'Plugins'})
|
||||||
.option('analyze-commits', {type: 'string', group: 'Plugins'})
|
.option('analyze-commits', {type: 'string', group: 'Plugins'})
|
||||||
.option('verify-release', {...stringList, group: 'Plugins'})
|
.option('verify-release', {...stringList, group: 'Plugins'})
|
||||||
@@ -29,16 +28,15 @@ Usage:
|
|||||||
.option('publish', {...stringList, group: 'Plugins'})
|
.option('publish', {...stringList, group: 'Plugins'})
|
||||||
.option('success', {...stringList, group: 'Plugins'})
|
.option('success', {...stringList, group: 'Plugins'})
|
||||||
.option('fail', {...stringList, group: 'Plugins'})
|
.option('fail', {...stringList, group: 'Plugins'})
|
||||||
.option('debug', {describe: 'Output debugging information', default: undefined, type: 'boolean', group: 'Options'})
|
.option('debug', {describe: 'Output debugging information', type: 'boolean', group: 'Options'})
|
||||||
.option('d', {alias: 'dry-run', describe: 'Skip publishing', default: undefined, type: 'boolean', group: 'Options'})
|
.option('d', {alias: 'dry-run', describe: 'Skip publishing', type: 'boolean', group: 'Options'})
|
||||||
.option('h', {alias: 'help', default: undefined, group: 'Options'})
|
.option('h', {alias: 'help', group: 'Options'})
|
||||||
.option('v', {alias: 'version', default: undefined, group: 'Options'})
|
.option('v', {alias: 'version', group: 'Options'})
|
||||||
.strict(false)
|
.strict(false)
|
||||||
.exitProcess(false);
|
.exitProcess(false);
|
||||||
|
|
||||||
try {
|
try {
|
||||||
// Remove option with undefined values, as yargs sets non defined options as `undefined`
|
const {help, version, ...opts} = cli.argv;
|
||||||
const {help, version, ...opts} = pickBy(cli.argv, value => !isUndefined(value));
|
|
||||||
|
|
||||||
if (Boolean(help) || Boolean(version)) {
|
if (Boolean(help) || Boolean(version)) {
|
||||||
process.exitCode = 0;
|
process.exitCode = 0;
|
||||||
|
|||||||
@@ -59,7 +59,7 @@ A `package.json` is required only for [local](../usage/installation.md#local-ins
|
|||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"semantic-release": "^12.0.0"
|
"semantic-release": "^15.0.0"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -51,7 +51,7 @@ A `package.json` is required only for [local](../usage/installation.md#local-ins
|
|||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"semantic-release": "^12.0.0"
|
"semantic-release": "^15.0.0"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -48,7 +48,7 @@ A `package.json` is required only for [local](../usage/installation.md#local-ins
|
|||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"semantic-release": "^12.0.0"
|
"semantic-release": "^15.0.0"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -83,8 +83,8 @@ A `package.json` is required only for [local](../usage/installation.md#local-ins
|
|||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"semantic-release": "^12.0.0",
|
"semantic-release": "^15.0.0",
|
||||||
"travis-deploy-once": "^4.0.0"
|
"travis-deploy-once": "^5.0.0"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -44,3 +44,13 @@ npm ERR! You do not have permission to publish "<package-name>". Are you logged
|
|||||||
This message is a little unclear, and might not have anything to with your `NPM_TOKEN` or authentication method. It might instead be related to the package name itself. If there is already a package with the same name as yours or, there is a very close match, it could trigger this error.
|
This message is a little unclear, and might not have anything to with your `NPM_TOKEN` or authentication method. It might instead be related to the package name itself. If there is already a package with the same name as yours or, there is a very close match, it could trigger this error.
|
||||||
|
|
||||||
Best way to be sure, is to search [npmjs.org](https://www.npmjs.com/)) using your package name. If there is a name conflict, rename your package in your `package.json`
|
Best way to be sure, is to search [npmjs.org](https://www.npmjs.com/)) using your package name. If there is a name conflict, rename your package in your `package.json`
|
||||||
|
|
||||||
|
## Squashed commits are ignored by **semantic-release**
|
||||||
|
|
||||||
|
**semantic-release** parses commits according to a [commit message convention](https://github.com/semantic-release/semantic-release#commit-message-format) to figure out how they affect the codebase. Commits that doesn't follow the project's commit message convention are simply ignored.
|
||||||
|
|
||||||
|
When [squashing commits](https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History#_squashing) most Git tools will by default generate a new commit message with a summary of the squashed commits. This commit message will most likely not be compliant with the project's commit message convention and therefore will be ignored by **semantic-release**.
|
||||||
|
|
||||||
|
When squashing commits make sure to rewrite the resulting commit message to be compliant with the project's commit message convention.
|
||||||
|
|
||||||
|
**Note**: if the resulting squashed commit would encompasses multiple changes (for example multiple unrelated features or fixes) then it's probably not a good idea to squash those commits together. A commit should contain exactly one self-contained functional change and a functional change should be contained in exactly one commit. See [atomic commits](https://en.wikipedia.org/wiki/Atomic_commit).
|
||||||
|
|||||||
@@ -24,6 +24,6 @@ For other type of projects we recommend installing **semantic-release** directly
|
|||||||
$ npx semantic-release
|
$ npx semantic-release
|
||||||
```
|
```
|
||||||
|
|
||||||
**Note:** For a global installation, it's recommended to specify the major **semantic-release** version to install (for example with with `npx semantic-release@12`, or `npm install -g semantic-release@12`). This way your build will not automatically use the next major **semantic-release** release that could possibly break your build. You will have to upgrade manually when a new major version is released.
|
**Note:** For a global installation, it's recommended to specify the major **semantic-release** version to install (for example with with `npx semantic-release@15`, or `npm install -g semantic-release@15`). This way your build will not automatically use the next major **semantic-release** release that could possibly break your build. You will have to upgrade manually when a new major version is released.
|
||||||
|
|
||||||
**Note:** `npx` is a tool bundled with `npm@>=5.2.0`. It is used to conveniently install the semantic-release binary and to execute it. See [What is npx](../support/FAQ.md#what-is-npx) for more details.
|
**Note:** `npx` is a tool bundled with `npm@>=5.2.0`. It is used to conveniently install the semantic-release binary and to execute it. See [What is npx](../support/FAQ.md#what-is-npx) for more details.
|
||||||
|
|||||||
@@ -91,7 +91,7 @@ For example:
|
|||||||
With this configuration:
|
With this configuration:
|
||||||
- the `custom-plugin` npm module will be used to [analyze commits](#analyzecommits-plugin)
|
- the `custom-plugin` npm module will be used to [analyze commits](#analyzecommits-plugin)
|
||||||
- the `./build/my-plugin.js` script will be used to [generate release notes](#generatenotes-plugin)
|
- the `./build/my-plugin.js` script will be used to [generate release notes](#generatenotes-plugin)
|
||||||
- the [`@semantic-release/exec`](https://github.com/semantic-release/exec), [`@semantic-release/npm`](https://github.com/semantic-release/npm) and [`@semantic-release/exec`](https://github.com/semantic-release/exec) plugins will be used to [verify conditions](#verifyconditions-plugin)
|
- the [`@semantic-release/exec`](https://github.com/semantic-release/exec), [`@semantic-release/npm`](https://github.com/semantic-release/npm) and [`@semantic-release/github`](https://github.com/semantic-release/github) plugins will be used to [verify conditions](#verifyconditions-plugin)
|
||||||
- the [`@semantic-release/exec`](https://github.com/semantic-release/exec) plugin will be used to [verify the release](#verifyrelease-plugin)
|
- the [`@semantic-release/exec`](https://github.com/semantic-release/exec) plugin will be used to [verify the release](#verifyrelease-plugin)
|
||||||
- the `cmd` option will be set to `verify-conditions.sh` only for the [`@semantic-release/exec`](https://github.com/semantic-release/exec) plugin used to [verify conditions](#verifyconditions-plugin)
|
- the `cmd` option will be set to `verify-conditions.sh` only for the [`@semantic-release/exec`](https://github.com/semantic-release/exec) plugin used to [verify conditions](#verifyconditions-plugin)
|
||||||
- the `cmd` option will be set to `verify-release.sh` only for the [`@semantic-release/exec`](https://github.com/semantic-release/exec) plugin used to [verify the release](#verifyrelease-plugin)
|
- the `cmd` option will be set to `verify-release.sh` only for the [`@semantic-release/exec`](https://github.com/semantic-release/exec) plugin used to [verify the release](#verifyrelease-plugin)
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ const getLastRelease = require('./lib/get-last-release');
|
|||||||
const {extractErrors} = require('./lib/utils');
|
const {extractErrors} = require('./lib/utils');
|
||||||
const getGitAuthUrl = require('./lib/get-git-auth-url');
|
const getGitAuthUrl = require('./lib/get-git-auth-url');
|
||||||
const logger = require('./lib/logger');
|
const logger = require('./lib/logger');
|
||||||
const {unshallow, verifyAuth, isBranchUpToDate, gitHead: getGitHead, tag, push} = require('./lib/git');
|
const {fetch, verifyAuth, isBranchUpToDate, gitHead: getGitHead, tag, push} = require('./lib/git');
|
||||||
const getError = require('./lib/get-error');
|
const getError = require('./lib/get-error');
|
||||||
const {COMMIT_NAME, COMMIT_EMAIL} = require('./lib/definitions/constants');
|
const {COMMIT_NAME, COMMIT_EMAIL} = require('./lib/definitions/constants');
|
||||||
|
|
||||||
@@ -54,22 +54,20 @@ async function run(options, plugins) {
|
|||||||
|
|
||||||
await verify(options);
|
await verify(options);
|
||||||
|
|
||||||
const {repositoryUrl} = options;
|
|
||||||
options.repositoryUrl = await getGitAuthUrl(options);
|
options.repositoryUrl = await getGitAuthUrl(options);
|
||||||
|
|
||||||
if (!(await isBranchUpToDate(options.branch))) {
|
|
||||||
logger.log(
|
|
||||||
"The local branch %s is behind the remote one, therefore a new version won't be published.",
|
|
||||||
options.branch
|
|
||||||
);
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
try {
|
try {
|
||||||
await verifyAuth(options.repositoryUrl, options.branch);
|
await verifyAuth(options.repositoryUrl, options.branch);
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
|
if (!(await isBranchUpToDate(options.repositoryUrl, options.branch))) {
|
||||||
|
logger.log(
|
||||||
|
"The local branch %s is behind the remote one, therefore a new version won't be published.",
|
||||||
|
options.branch
|
||||||
|
);
|
||||||
|
return false;
|
||||||
|
}
|
||||||
logger.error(`The command "${err.cmd}" failed with the error message %s.`, err.stderr);
|
logger.error(`The command "${err.cmd}" failed with the error message %s.`, err.stderr);
|
||||||
throw getError('EGITNOPERMISSION', {options, repositoryUrl});
|
throw getError('EGITNOPERMISSION', {options});
|
||||||
}
|
}
|
||||||
|
|
||||||
logger.log('Run automated release from branch %s', options.branch);
|
logger.log('Run automated release from branch %s', options.branch);
|
||||||
@@ -77,8 +75,7 @@ async function run(options, plugins) {
|
|||||||
logger.log('Call plugin %s', 'verify-conditions');
|
logger.log('Call plugin %s', 'verify-conditions');
|
||||||
await plugins.verifyConditions({options, logger}, {settleAll: true});
|
await plugins.verifyConditions({options, logger}, {settleAll: true});
|
||||||
|
|
||||||
// Unshallow the repo in order to get all the tags
|
await fetch(options.repositoryUrl);
|
||||||
await unshallow(options.repositoryUrl);
|
|
||||||
|
|
||||||
const lastRelease = await getLastRelease(options.tagFormat, logger);
|
const lastRelease = await getLastRelease(options.tagFormat, logger);
|
||||||
const commits = await getCommits(lastRelease.gitHead, options.branch, logger);
|
const commits = await getCommits(lastRelease.gitHead, options.branch, logger);
|
||||||
|
|||||||
@@ -27,11 +27,11 @@ Please make sure to add the \`repositoryUrl\` to the [semantic-release configura
|
|||||||
'docs/usage/configuration.md'
|
'docs/usage/configuration.md'
|
||||||
)}).`,
|
)}).`,
|
||||||
}),
|
}),
|
||||||
EGITNOPERMISSION: ({options, repositoryUrl}) => ({
|
EGITNOPERMISSION: ({options}) => ({
|
||||||
message: 'The push permission to the Git repository is required.',
|
message: 'The push permission to the Git repository is required.',
|
||||||
details: `**semantic-release** cannot push the version tag to the branch \`${
|
details: `**semantic-release** cannot push the version tag to the branch \`${
|
||||||
options.branch
|
options.branch
|
||||||
}\` on remote Git repository with URL \`${repositoryUrl}\`.
|
}\` on remote Git repository with URL \`${options.repositoryUrl}\`.
|
||||||
|
|
||||||
Please refer to the [authentication configuration documentation](${linkify(
|
Please refer to the [authentication configuration documentation](${linkify(
|
||||||
'docs/usage/ci-configuration.md#authentication'
|
'docs/usage/ci-configuration.md#authentication'
|
||||||
|
|||||||
@@ -45,7 +45,7 @@ module.exports = {
|
|||||||
publish: {
|
publish: {
|
||||||
default: ['@semantic-release/npm', '@semantic-release/github'],
|
default: ['@semantic-release/npm', '@semantic-release/github'],
|
||||||
config: {
|
config: {
|
||||||
validator: conf => Boolean(conf) && (isArray(conf) ? conf : [conf]).every(conf => validatePluginConfig(conf)),
|
validator: conf => !conf || (isArray(conf) ? conf : [conf]).every(conf => validatePluginConfig(conf)),
|
||||||
},
|
},
|
||||||
output: {
|
output: {
|
||||||
validator: output => !output || isPlainObject(output),
|
validator: output => !output || isPlainObject(output),
|
||||||
|
|||||||
+17
-6
@@ -49,12 +49,16 @@ async function isRefInHistory(ref) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Unshallow the git repository (retriving every commits and tags).
|
* Unshallow the git repository if necessary and fetch all the tags.
|
||||||
*
|
*
|
||||||
* @param {String} repositoryUrl The remote repository URL.
|
* @param {String} repositoryUrl The remote repository URL.
|
||||||
*/
|
*/
|
||||||
async function unshallow(repositoryUrl) {
|
async function fetch(repositoryUrl) {
|
||||||
await execa('git', ['fetch', '--unshallow', '--tags', repositoryUrl], {reject: false});
|
try {
|
||||||
|
await execa('git', ['fetch', '--unshallow', '--tags', repositoryUrl]);
|
||||||
|
} catch (err) {
|
||||||
|
await execa('git', ['fetch', '--tags', repositoryUrl]);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -141,19 +145,26 @@ async function verifyTagName(tagName) {
|
|||||||
/**
|
/**
|
||||||
* Verify the local branch is up to date with the remote one.
|
* Verify the local branch is up to date with the remote one.
|
||||||
*
|
*
|
||||||
|
* @param {String} repositoryUrl The remote repository URL.
|
||||||
* @param {String} branch The repository branch for which to verify status.
|
* @param {String} branch The repository branch for which to verify status.
|
||||||
*
|
*
|
||||||
* @return {Boolean} `true` is the HEAD of the current local branch is the same as the HEAD of the remote branch, falsy otherwise.
|
* @return {Boolean} `true` is the HEAD of the current local branch is the same as the HEAD of the remote branch, falsy otherwise.
|
||||||
*/
|
*/
|
||||||
async function isBranchUpToDate(branch) {
|
async function isBranchUpToDate(repositoryUrl, branch) {
|
||||||
return isRefInHistory(await execa.stdout('git', ['rev-parse', `origin/${branch}`]));
|
try {
|
||||||
|
return await isRefInHistory(
|
||||||
|
(await execa.stdout('git', ['ls-remote', '--heads', repositoryUrl, branch])).match(/^(\w+)?/)[1]
|
||||||
|
);
|
||||||
|
} catch (err) {
|
||||||
|
debug(err);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
module.exports = {
|
module.exports = {
|
||||||
gitTagHead,
|
gitTagHead,
|
||||||
gitTags,
|
gitTags,
|
||||||
isRefInHistory,
|
isRefInHistory,
|
||||||
unshallow,
|
fetch,
|
||||||
gitHead,
|
gitHead,
|
||||||
repoUrl,
|
repoUrl,
|
||||||
isGitRepo,
|
isGitRepo,
|
||||||
|
|||||||
+5
-5
@@ -35,16 +35,16 @@
|
|||||||
"git-log-parser": "^1.2.0",
|
"git-log-parser": "^1.2.0",
|
||||||
"git-url-parse": "^9.0.0",
|
"git-url-parse": "^9.0.0",
|
||||||
"hook-std": "^1.0.1",
|
"hook-std": "^1.0.1",
|
||||||
"hosted-git-info": "^2.6.0",
|
"hosted-git-info": "^2.7.1",
|
||||||
"lodash": "^4.17.4",
|
"lodash": "^4.17.4",
|
||||||
"marked": "^0.4.0",
|
"marked": "^0.4.0",
|
||||||
"marked-terminal": "^3.0.0",
|
"marked-terminal": "^3.0.0",
|
||||||
"p-locate": "^2.0.0",
|
"p-locate": "^3.0.0",
|
||||||
"p-reduce": "^1.0.0",
|
"p-reduce": "^1.0.0",
|
||||||
"read-pkg-up": "^3.0.0",
|
"read-pkg-up": "^4.0.0",
|
||||||
"resolve-from": "^4.0.0",
|
"resolve-from": "^4.0.0",
|
||||||
"semver": "^5.4.1",
|
"semver": "^5.4.1",
|
||||||
"yargs": "^11.0.0"
|
"yargs": "^12.0.0"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"ava": "^0.25.0",
|
"ava": "^0.25.0",
|
||||||
@@ -63,7 +63,7 @@
|
|||||||
"nyc": "^12.0.1",
|
"nyc": "^12.0.1",
|
||||||
"p-retry": "^2.0.0",
|
"p-retry": "^2.0.0",
|
||||||
"proxyquire": "^2.0.0",
|
"proxyquire": "^2.0.0",
|
||||||
"sinon": "^5.0.1",
|
"sinon": "^6.0.0",
|
||||||
"tempy": "^0.2.1",
|
"tempy": "^0.2.1",
|
||||||
"xo": "^0.21.0"
|
"xo": "^0.21.0"
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -60,9 +60,9 @@ test('The "prepare" plugin, if defined, must be a single or an array of plugins
|
|||||||
test('The "publish" plugin is mandatory, and must be a single or an array of plugins definition', t => {
|
test('The "publish" plugin is mandatory, and must be a single or an array of plugins definition', t => {
|
||||||
t.false(plugins.publish.config.validator({}));
|
t.false(plugins.publish.config.validator({}));
|
||||||
t.false(plugins.publish.config.validator({path: null}));
|
t.false(plugins.publish.config.validator({path: null}));
|
||||||
t.false(plugins.publish.config.validator());
|
|
||||||
|
|
||||||
t.true(plugins.publish.config.validator({path: 'plugin-path.js'}));
|
t.true(plugins.publish.config.validator({path: 'plugin-path.js'}));
|
||||||
|
t.true(plugins.publish.config.validator());
|
||||||
t.true(plugins.publish.config.validator('plugin-path.js'));
|
t.true(plugins.publish.config.validator('plugin-path.js'));
|
||||||
t.true(plugins.publish.config.validator(() => {}));
|
t.true(plugins.publish.config.validator(() => {}));
|
||||||
t.true(plugins.publish.config.validator([{path: 'plugin-path.js'}, 'plugin-path.js', () => {}]));
|
t.true(plugins.publish.config.validator([{path: 'plugin-path.js'}, 'plugin-path.js', () => {}]));
|
||||||
|
|||||||
+38
-17
@@ -3,7 +3,7 @@ import tempy from 'tempy';
|
|||||||
import {
|
import {
|
||||||
gitTagHead,
|
gitTagHead,
|
||||||
isRefInHistory,
|
isRefInHistory,
|
||||||
unshallow,
|
fetch,
|
||||||
gitHead,
|
gitHead,
|
||||||
repoUrl,
|
repoUrl,
|
||||||
tag,
|
tag,
|
||||||
@@ -23,8 +23,8 @@ import {
|
|||||||
gitAddConfig,
|
gitAddConfig,
|
||||||
gitCommitTag,
|
gitCommitTag,
|
||||||
gitRemoteTagHead,
|
gitRemoteTagHead,
|
||||||
push as pushUtil,
|
gitPush,
|
||||||
reset,
|
gitDetachedHead,
|
||||||
} from './helpers/git-utils';
|
} from './helpers/git-utils';
|
||||||
|
|
||||||
// Save the current working diretory
|
// Save the current working diretory
|
||||||
@@ -53,7 +53,7 @@ test.serial('Throw error if the last commit sha cannot be found', async t => {
|
|||||||
await t.throws(gitHead(), Error);
|
await t.throws(gitHead(), Error);
|
||||||
});
|
});
|
||||||
|
|
||||||
test.serial('Unshallow repository', async t => {
|
test.serial('Unshallow and fetch repository', async t => {
|
||||||
// Create a git repository, set the current working directory at the root of the repo
|
// Create a git repository, set the current working directory at the root of the repo
|
||||||
const repo = await gitRepo();
|
const repo = await gitRepo();
|
||||||
// Add commits to the master branch
|
// Add commits to the master branch
|
||||||
@@ -64,7 +64,7 @@ test.serial('Unshallow repository', async t => {
|
|||||||
// Verify the shallow clone contains only one commit
|
// Verify the shallow clone contains only one commit
|
||||||
t.is((await gitGetCommits()).length, 1);
|
t.is((await gitGetCommits()).length, 1);
|
||||||
|
|
||||||
await unshallow(repo);
|
await fetch(repo);
|
||||||
|
|
||||||
// Verify the shallow clone contains all the commits
|
// Verify the shallow clone contains all the commits
|
||||||
t.is((await gitGetCommits()).length, 2);
|
t.is((await gitGetCommits()).length, 2);
|
||||||
@@ -75,7 +75,24 @@ test.serial('Do not throw error when unshallow a complete repository', async t =
|
|||||||
const repo = await gitRepo();
|
const repo = await gitRepo();
|
||||||
// Add commits to the master branch
|
// Add commits to the master branch
|
||||||
await gitCommits(['First']);
|
await gitCommits(['First']);
|
||||||
await t.notThrows(unshallow(repo));
|
await t.notThrows(fetch(repo));
|
||||||
|
});
|
||||||
|
|
||||||
|
test.serial('Fetch all tags on a detached head repository', async t => {
|
||||||
|
const repo = await gitRepo(true);
|
||||||
|
|
||||||
|
await gitCommits(['First']);
|
||||||
|
await gitTagVersion('v1.0.0');
|
||||||
|
await gitCommits(['Second']);
|
||||||
|
await gitTagVersion('v1.0.1');
|
||||||
|
const [commit] = await gitCommits(['Third']);
|
||||||
|
await gitTagVersion('v1.1.0');
|
||||||
|
await gitPush();
|
||||||
|
await gitDetachedHead(repo, commit.hash);
|
||||||
|
|
||||||
|
await fetch(repo);
|
||||||
|
|
||||||
|
t.deepEqual((await gitTags()).sort(), ['v1.0.0', 'v1.0.1', 'v1.1.0'].sort());
|
||||||
});
|
});
|
||||||
|
|
||||||
test.serial('Verify if the commit `sha` is in the direct history of the current branch', async t => {
|
test.serial('Verify if the commit `sha` is in the direct history of the current branch', async t => {
|
||||||
@@ -189,31 +206,35 @@ test.serial('Throws error if obtaining the tags fails', async t => {
|
|||||||
});
|
});
|
||||||
|
|
||||||
test.serial('Return "true" if repository is up to date', async t => {
|
test.serial('Return "true" if repository is up to date', async t => {
|
||||||
await gitRepo(true);
|
const repositoryUrl = await gitRepo(true);
|
||||||
await gitCommits(['First']);
|
await gitCommits(['First']);
|
||||||
await pushUtil();
|
await gitPush();
|
||||||
|
|
||||||
t.true(await isBranchUpToDate('master'));
|
t.true(await isBranchUpToDate(repositoryUrl, 'master'));
|
||||||
});
|
});
|
||||||
|
|
||||||
test.serial('Return falsy if repository is not up to date', async t => {
|
test.serial('Return falsy if repository is not up to date', async t => {
|
||||||
await gitRepo(true);
|
const repositoryUrl = await gitRepo(true);
|
||||||
|
const repoDir = process.cwd();
|
||||||
await gitCommits(['First']);
|
await gitCommits(['First']);
|
||||||
await gitCommits(['Second']);
|
await gitCommits(['Second']);
|
||||||
await pushUtil();
|
await gitPush();
|
||||||
|
|
||||||
t.true(await isBranchUpToDate('master'));
|
t.true(await isBranchUpToDate(repositoryUrl, 'master'));
|
||||||
|
|
||||||
await reset();
|
await gitShallowClone(repositoryUrl);
|
||||||
|
await gitCommits(['Third']);
|
||||||
|
await gitPush();
|
||||||
|
process.chdir(repoDir);
|
||||||
|
|
||||||
t.falsy(await isBranchUpToDate('master'));
|
t.falsy(await isBranchUpToDate(repositoryUrl, 'master'));
|
||||||
});
|
});
|
||||||
|
|
||||||
test.serial('Return "true" if local repository is ahead', async t => {
|
test.serial('Return "true" if local repository is ahead', async t => {
|
||||||
await gitRepo(true);
|
const repositoryUrl = await gitRepo(true);
|
||||||
await gitCommits(['First']);
|
await gitCommits(['First']);
|
||||||
await pushUtil();
|
await gitPush();
|
||||||
await gitCommits(['Second']);
|
await gitCommits(['Second']);
|
||||||
|
|
||||||
t.true(await isBranchUpToDate('master'));
|
t.true(await isBranchUpToDate(repositoryUrl, 'master'));
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -151,7 +151,7 @@ export async function gitDetachedHead(repositoryUrl, head) {
|
|||||||
process.chdir(dir);
|
process.chdir(dir);
|
||||||
await execa('git', ['init']);
|
await execa('git', ['init']);
|
||||||
await execa('git', ['remote', 'add', 'origin', repositoryUrl]);
|
await execa('git', ['remote', 'add', 'origin', repositoryUrl]);
|
||||||
await execa('git', ['fetch']);
|
await execa('git', ['fetch', repositoryUrl]);
|
||||||
await execa('git', ['checkout', head]);
|
await execa('git', ['checkout', head]);
|
||||||
return dir;
|
return dir;
|
||||||
}
|
}
|
||||||
@@ -209,15 +209,6 @@ export async function gitCommitTag(gitHead) {
|
|||||||
* @param {String} branch The branch to push.
|
* @param {String} branch The branch to push.
|
||||||
* @throws {Error} if the push failed.
|
* @throws {Error} if the push failed.
|
||||||
*/
|
*/
|
||||||
export async function push(repositoryUrl = 'origin', branch = 'master') {
|
export async function gitPush(repositoryUrl = 'origin', branch = 'master') {
|
||||||
await execa('git', ['push', '--tags', repositoryUrl, `HEAD:${branch}`]);
|
await execa('git', ['push', '--tags', repositoryUrl, `HEAD:${branch}`]);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Reset repository to a commit.
|
|
||||||
*
|
|
||||||
* @param {String} [commit='HEAD~1'] Commit reference to reset the repo to.
|
|
||||||
*/
|
|
||||||
export async function reset(commit = 'HEAD~1') {
|
|
||||||
await execa('git', ['reset', commit]);
|
|
||||||
}
|
|
||||||
|
|||||||
+22
-19
@@ -13,9 +13,8 @@ import {
|
|||||||
gitCommits,
|
gitCommits,
|
||||||
gitTagVersion,
|
gitTagVersion,
|
||||||
gitRemoteTagHead,
|
gitRemoteTagHead,
|
||||||
push,
|
gitPush,
|
||||||
gitShallowClone,
|
gitShallowClone,
|
||||||
reset,
|
|
||||||
} from './helpers/git-utils';
|
} from './helpers/git-utils';
|
||||||
|
|
||||||
// Save the current process.env
|
// Save the current process.env
|
||||||
@@ -59,7 +58,7 @@ test.serial('Plugins are called with expected values', async t => {
|
|||||||
await gitTagVersion('v1.0.0');
|
await gitTagVersion('v1.0.0');
|
||||||
// Add new commits to the master branch
|
// Add new commits to the master branch
|
||||||
commits = (await gitCommits(['Second'])).concat(commits);
|
commits = (await gitCommits(['Second'])).concat(commits);
|
||||||
await push();
|
await gitPush();
|
||||||
|
|
||||||
const lastRelease = {version: '1.0.0', gitHead: commits[commits.length - 1].hash, gitTag: 'v1.0.0'};
|
const lastRelease = {version: '1.0.0', gitHead: commits[commits.length - 1].hash, gitTag: 'v1.0.0'};
|
||||||
const nextRelease = {type: 'major', version: '2.0.0', gitHead: await getGitHead(), gitTag: 'v2.0.0'};
|
const nextRelease = {type: 'major', version: '2.0.0', gitHead: await getGitHead(), gitTag: 'v2.0.0'};
|
||||||
@@ -171,7 +170,7 @@ test.serial('Use custom tag format', async t => {
|
|||||||
await gitCommits(['First']);
|
await gitCommits(['First']);
|
||||||
await gitTagVersion('test-1.0.0');
|
await gitTagVersion('test-1.0.0');
|
||||||
await gitCommits(['Second']);
|
await gitCommits(['Second']);
|
||||||
await push();
|
await gitPush();
|
||||||
|
|
||||||
const nextRelease = {type: 'major', version: '2.0.0', gitHead: await getGitHead(), gitTag: 'test-2.0.0'};
|
const nextRelease = {type: 'major', version: '2.0.0', gitHead: await getGitHead(), gitTag: 'test-2.0.0'};
|
||||||
const notes = 'Release notes';
|
const notes = 'Release notes';
|
||||||
@@ -208,7 +207,7 @@ test.serial('Use new gitHead, and recreate release notes if a prepare plugin cre
|
|||||||
await gitTagVersion('v1.0.0');
|
await gitTagVersion('v1.0.0');
|
||||||
// Add new commits to the master branch
|
// Add new commits to the master branch
|
||||||
commits = (await gitCommits(['Second'])).concat(commits);
|
commits = (await gitCommits(['Second'])).concat(commits);
|
||||||
await push();
|
await gitPush();
|
||||||
|
|
||||||
const nextRelease = {type: 'major', version: '2.0.0', gitHead: await getGitHead(), gitTag: 'v2.0.0'};
|
const nextRelease = {type: 'major', version: '2.0.0', gitHead: await getGitHead(), gitTag: 'v2.0.0'};
|
||||||
const notes = 'Release notes';
|
const notes = 'Release notes';
|
||||||
@@ -268,7 +267,7 @@ test.serial('Call all "success" plugins even if one errors out', async t => {
|
|||||||
await gitTagVersion('v1.0.0');
|
await gitTagVersion('v1.0.0');
|
||||||
// Add new commits to the master branch
|
// Add new commits to the master branch
|
||||||
await gitCommits(['Second']);
|
await gitCommits(['Second']);
|
||||||
await push();
|
await gitPush();
|
||||||
|
|
||||||
const nextRelease = {type: 'major', version: '2.0.0', gitHead: await getGitHead(), gitTag: 'v2.0.0'};
|
const nextRelease = {type: 'major', version: '2.0.0', gitHead: await getGitHead(), gitTag: 'v2.0.0'};
|
||||||
const notes = 'Release notes';
|
const notes = 'Release notes';
|
||||||
@@ -316,7 +315,7 @@ test.serial('Log all "verifyConditions" errors', async t => {
|
|||||||
const repositoryUrl = await gitRepo(true);
|
const repositoryUrl = await gitRepo(true);
|
||||||
// Add commits to the master branch
|
// Add commits to the master branch
|
||||||
await gitCommits(['First']);
|
await gitCommits(['First']);
|
||||||
await push();
|
await gitPush();
|
||||||
|
|
||||||
const error1 = new Error('error 1');
|
const error1 = new Error('error 1');
|
||||||
const error2 = new SemanticReleaseError('error 2', 'ERR2');
|
const error2 = new SemanticReleaseError('error 2', 'ERR2');
|
||||||
@@ -359,7 +358,7 @@ test.serial('Log all "verifyRelease" errors', async t => {
|
|||||||
await gitTagVersion('v1.0.0');
|
await gitTagVersion('v1.0.0');
|
||||||
// Add new commits to the master branch
|
// Add new commits to the master branch
|
||||||
await gitCommits(['Second']);
|
await gitCommits(['Second']);
|
||||||
await push();
|
await gitPush();
|
||||||
|
|
||||||
const error1 = new SemanticReleaseError('error 1', 'ERR1');
|
const error1 = new SemanticReleaseError('error 1', 'ERR1');
|
||||||
const error2 = new SemanticReleaseError('error 2', 'ERR2');
|
const error2 = new SemanticReleaseError('error 2', 'ERR2');
|
||||||
@@ -396,7 +395,7 @@ test.serial('Dry-run skips publish and success', async t => {
|
|||||||
await gitTagVersion('v1.0.0');
|
await gitTagVersion('v1.0.0');
|
||||||
// Add new commits to the master branch
|
// Add new commits to the master branch
|
||||||
await gitCommits(['Second']);
|
await gitCommits(['Second']);
|
||||||
await push();
|
await gitPush();
|
||||||
|
|
||||||
const nextRelease = {type: 'major', version: '2.0.0', gitHead: await getGitHead(), gitTag: 'v2.0.0'};
|
const nextRelease = {type: 'major', version: '2.0.0', gitHead: await getGitHead(), gitTag: 'v2.0.0'};
|
||||||
const notes = 'Release notes';
|
const notes = 'Release notes';
|
||||||
@@ -445,7 +444,7 @@ test.serial('Dry-run skips fail', async t => {
|
|||||||
await gitTagVersion('v1.0.0');
|
await gitTagVersion('v1.0.0');
|
||||||
// Add new commits to the master branch
|
// Add new commits to the master branch
|
||||||
await gitCommits(['Second']);
|
await gitCommits(['Second']);
|
||||||
await push();
|
await gitPush();
|
||||||
|
|
||||||
const error1 = new SemanticReleaseError('error 1', 'ERR1');
|
const error1 = new SemanticReleaseError('error 1', 'ERR1');
|
||||||
const error2 = new SemanticReleaseError('error 2', 'ERR2');
|
const error2 = new SemanticReleaseError('error 2', 'ERR2');
|
||||||
@@ -480,7 +479,7 @@ test.serial('Force a dry-run if not on a CI and "noCi" is not explicitly set', a
|
|||||||
await gitTagVersion('v1.0.0');
|
await gitTagVersion('v1.0.0');
|
||||||
// Add new commits to the master branch
|
// Add new commits to the master branch
|
||||||
await gitCommits(['Second']);
|
await gitCommits(['Second']);
|
||||||
await push();
|
await gitPush();
|
||||||
|
|
||||||
const nextRelease = {type: 'major', version: '2.0.0', gitHead: await getGitHead(), gitTag: 'v2.0.0'};
|
const nextRelease = {type: 'major', version: '2.0.0', gitHead: await getGitHead(), gitTag: 'v2.0.0'};
|
||||||
const notes = 'Release notes';
|
const notes = 'Release notes';
|
||||||
@@ -530,7 +529,7 @@ test.serial('Allow local releases with "noCi" option', async t => {
|
|||||||
await gitTagVersion('v1.0.0');
|
await gitTagVersion('v1.0.0');
|
||||||
// Add new commits to the master branch
|
// Add new commits to the master branch
|
||||||
await gitCommits(['Second']);
|
await gitCommits(['Second']);
|
||||||
await push();
|
await gitPush();
|
||||||
|
|
||||||
const nextRelease = {type: 'major', version: '2.0.0', gitHead: await getGitHead(), gitTag: 'v2.0.0'};
|
const nextRelease = {type: 'major', version: '2.0.0', gitHead: await getGitHead(), gitTag: 'v2.0.0'};
|
||||||
const notes = 'Release notes';
|
const notes = 'Release notes';
|
||||||
@@ -584,7 +583,7 @@ test.serial('Accept "undefined" value returned by the "generateNotes" plugins',
|
|||||||
await gitTagVersion('v1.0.0');
|
await gitTagVersion('v1.0.0');
|
||||||
// Add new commits to the master branch
|
// Add new commits to the master branch
|
||||||
commits = (await gitCommits(['Second'])).concat(commits);
|
commits = (await gitCommits(['Second'])).concat(commits);
|
||||||
await push();
|
await gitPush();
|
||||||
|
|
||||||
const lastRelease = {version: '1.0.0', gitHead: commits[commits.length - 1].hash, gitTag: 'v1.0.0'};
|
const lastRelease = {version: '1.0.0', gitHead: commits[commits.length - 1].hash, gitTag: 'v1.0.0'};
|
||||||
const nextRelease = {type: 'major', version: '2.0.0', gitHead: await getGitHead(), gitTag: 'v2.0.0'};
|
const nextRelease = {type: 'major', version: '2.0.0', gitHead: await getGitHead(), gitTag: 'v2.0.0'};
|
||||||
@@ -645,11 +644,15 @@ test.serial('Returns falsy value if triggered by a PR', async t => {
|
|||||||
test.serial('Returns falsy value if triggered on an outdated clone', async t => {
|
test.serial('Returns falsy value if triggered on an outdated clone', async t => {
|
||||||
// Create a git repository, set the current working directory at the root of the repo
|
// Create a git repository, set the current working directory at the root of the repo
|
||||||
const repositoryUrl = await gitRepo(true);
|
const repositoryUrl = await gitRepo(true);
|
||||||
|
const repoDir = process.cwd();
|
||||||
// Add commits to the master branch
|
// Add commits to the master branch
|
||||||
await gitCommits(['First']);
|
await gitCommits(['First']);
|
||||||
await gitCommits(['Second']);
|
await gitCommits(['Second']);
|
||||||
await push();
|
await gitPush();
|
||||||
await reset();
|
await gitShallowClone(repositoryUrl);
|
||||||
|
await gitCommits(['Third']);
|
||||||
|
await gitPush();
|
||||||
|
process.chdir(repoDir);
|
||||||
|
|
||||||
const semanticRelease = proxyquire('..', {
|
const semanticRelease = proxyquire('..', {
|
||||||
'./lib/logger': t.context.logger,
|
'./lib/logger': t.context.logger,
|
||||||
@@ -696,7 +699,7 @@ test.serial('Returns falsy value if there is no relevant changes', async t => {
|
|||||||
const repositoryUrl = await gitRepo(true);
|
const repositoryUrl = await gitRepo(true);
|
||||||
// Add commits to the master branch
|
// Add commits to the master branch
|
||||||
await gitCommits(['First']);
|
await gitCommits(['First']);
|
||||||
await push();
|
await gitPush();
|
||||||
|
|
||||||
const analyzeCommits = stub().resolves();
|
const analyzeCommits = stub().resolves();
|
||||||
const verifyRelease = stub().resolves();
|
const verifyRelease = stub().resolves();
|
||||||
@@ -746,7 +749,7 @@ test.serial('Exclude commits with [skip release] or [release skip] from analysis
|
|||||||
'Test commit\n\n commit body\n[skip release]',
|
'Test commit\n\n commit body\n[skip release]',
|
||||||
'Test commit\n\n commit body\n[release skip]',
|
'Test commit\n\n commit body\n[release skip]',
|
||||||
]);
|
]);
|
||||||
await push();
|
await gitPush();
|
||||||
const analyzeCommits = stub().resolves();
|
const analyzeCommits = stub().resolves();
|
||||||
const config = {branch: 'master', repositoryUrl, globalOpt: 'global'};
|
const config = {branch: 'master', repositoryUrl, globalOpt: 'global'};
|
||||||
const options = {
|
const options = {
|
||||||
@@ -871,7 +874,7 @@ test.serial('Throw an Error if plugin returns an unexpected value', async t => {
|
|||||||
await gitTagVersion('v1.0.0');
|
await gitTagVersion('v1.0.0');
|
||||||
// Add new commits to the master branch
|
// Add new commits to the master branch
|
||||||
await gitCommits(['Second']);
|
await gitCommits(['Second']);
|
||||||
await push();
|
await gitPush();
|
||||||
|
|
||||||
const verifyConditions = stub().resolves();
|
const verifyConditions = stub().resolves();
|
||||||
const analyzeCommits = stub().resolves('string');
|
const analyzeCommits = stub().resolves('string');
|
||||||
@@ -900,7 +903,7 @@ test.serial('Get all commits including the ones not in the shallow clone', async
|
|||||||
const repositoryUrl = await gitRepo(true);
|
const repositoryUrl = await gitRepo(true);
|
||||||
await gitTagVersion('v1.0.0');
|
await gitTagVersion('v1.0.0');
|
||||||
await gitCommits(['First', 'Second', 'Third']);
|
await gitCommits(['First', 'Second', 'Third']);
|
||||||
await push(repositoryUrl, 'master');
|
await gitPush(repositoryUrl, 'master');
|
||||||
|
|
||||||
await gitShallowClone(repositoryUrl);
|
await gitShallowClone(repositoryUrl);
|
||||||
|
|
||||||
|
|||||||
@@ -2,7 +2,7 @@ import test from 'ava';
|
|||||||
import {writeJson, readJson} from 'fs-extra';
|
import {writeJson, readJson} from 'fs-extra';
|
||||||
import {stub} from 'sinon';
|
import {stub} from 'sinon';
|
||||||
import execa from 'execa';
|
import execa from 'execa';
|
||||||
import {gitHead as getGitHead, gitTagHead, gitRepo, gitCommits, gitRemoteTagHead} from './helpers/git-utils';
|
import {gitHead as getGitHead, gitTagHead, gitRepo, gitCommits, gitRemoteTagHead, gitPush} from './helpers/git-utils';
|
||||||
import gitbox from './helpers/gitbox';
|
import gitbox from './helpers/gitbox';
|
||||||
import mockServer from './helpers/mockserver';
|
import mockServer from './helpers/mockserver';
|
||||||
import npmRegistry from './helpers/npm-registry';
|
import npmRegistry from './helpers/npm-registry';
|
||||||
@@ -609,6 +609,7 @@ test.serial('Exit with 1 if missing permission to push to the remote repository'
|
|||||||
/* Initial release */
|
/* Initial release */
|
||||||
t.log('Commit a feature');
|
t.log('Commit a feature');
|
||||||
await gitCommits(['feat: Initial commit']);
|
await gitCommits(['feat: Initial commit']);
|
||||||
|
await gitPush();
|
||||||
t.log('$ semantic-release');
|
t.log('$ semantic-release');
|
||||||
const {stdout, code} = await execa(
|
const {stdout, code} = await execa(
|
||||||
cli,
|
cli,
|
||||||
|
|||||||
Reference in New Issue
Block a user