simon/semantic-release
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

refactor: harmonize git utils function names

Browse Source
This commit is contained in:
Pierre Vanduynslager 2018-11-19 18:23:42 -05:00
parent e594638a96
commit 9f5645cfa0
6 changed files with 57 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
index.js
View File

@ -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 getLogger = require('./lib/get-logger'); const getLogger = require('./lib/get-logger');
const {fetch, verifyAuth, isBranchUpToDate, gitHead: getGitHead, tag, push} = require('./lib/git'); const {fetch, verifyAuth, isBranchUpToDate, 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');

4
lib/definitions/plugins.js
View File

@ -1,5 +1,5 @@
const {isString, isPlainObject} = require('lodash'); const {isString, isPlainObject} = require('lodash');
const {gitHead} = require('../git'); const {getGitHead} = require('../git');
const hideSensitive = require('../hide-sensitive'); const hideSensitive = require('../hide-sensitive');
const {hideSensitiveValues} = require('../utils'); const {hideSensitiveValues} = require('../utils');
const {RELEASE_TYPE, RELEASE_NOTES_SEPARATOR} = require('./constants'); const {RELEASE_TYPE, RELEASE_NOTES_SEPARATOR} = require('./constants');
@ -52,7 +52,7 @@ module.exports = {
dryRun: false, dryRun: false,
pipelineConfig: ({generateNotes}) => ({ pipelineConfig: ({generateNotes}) => ({
getNextInput: async context => { getNextInput: async context => {
const newGitHead = await gitHead({cwd: context.cwd}); const newGitHead = await getGitHead({cwd: context.cwd});
// If previous prepare plugin has created a commit (gitHead changed) // If previous prepare plugin has created a commit (gitHead changed)
if (context.nextRelease.gitHead !== newGitHead) { if (context.nextRelease.gitHead !== newGitHead) {
context.nextRelease.gitHead = newGitHead; context.nextRelease.gitHead = newGitHead;

6
lib/get-last-release.js
View File

@ -2,7 +2,7 @@ const {escapeRegExp, template} = require('lodash');
const semver = require('semver'); const semver = require('semver');
const pLocate = require('p-locate'); const pLocate = require('p-locate');
const debug = require('debug')('semantic-release:get-last-release'); const debug = require('debug')('semantic-release:get-last-release');
const {gitTags, isRefInHistory, gitTagHead} = require('./git'); const {getTags, isRefInHistory, getTagHead} = require('./git');
/** /**
* Last release. * Last release.
@ -30,7 +30,7 @@ module.exports = async ({cwd, env, options: {tagFormat}, logger}) => {
// The `tagFormat` is compiled with space as the `version` as it's an invalid tag character, // The `tagFormat` is compiled with space as the `version` as it's an invalid tag character,
// so it's guaranteed to no be present in the `tagFormat`. // so it's guaranteed to no be present in the `tagFormat`.
const tagRegexp = `^${escapeRegExp(template(tagFormat)({version: ' '})).replace(' ', '(.+)')}`; const tagRegexp = `^${escapeRegExp(template(tagFormat)({version: ' '})).replace(' ', '(.+)')}`;
const tags = (await gitTags({cwd, env})) const tags = (await getTags({cwd, env}))
.map(tag => ({gitTag: tag, version: (tag.match(tagRegexp) || new Array(2))[1]})) .map(tag => ({gitTag: tag, version: (tag.match(tagRegexp) || new Array(2))[1]}))
.filter( .filter(
tag => tag.version && semver.valid(semver.clean(tag.version)) && !semver.prerelease(semver.clean(tag.version)) tag => tag.version && semver.valid(semver.clean(tag.version)) && !semver.prerelease(semver.clean(tag.version))
@ -43,7 +43,7 @@ module.exports = async ({cwd, env, options: {tagFormat}, logger}) => {
if (tag) { if (tag) {
logger.log(`Found git tag ${tag.gitTag} associated with version ${tag.version}`); logger.log(`Found git tag ${tag.gitTag} associated with version ${tag.version}`);
return {gitHead: await gitTagHead(tag.gitTag, {cwd, env}), ...tag}; return {gitHead: await getTagHead(tag.gitTag, {cwd, env}), ...tag};
} }
logger.log('No git tag version found'); logger.log('No git tag version found');

12
lib/git.js
View File

@ -9,7 +9,7 @@ const debug = require('debug')('semantic-release:git');
* *
* @return {string} The commit sha of the tag in parameter or `null`. * @return {string} The commit sha of the tag in parameter or `null`.
*/ */
async function gitTagHead(tagName, execaOpts) { async function getTagHead(tagName, execaOpts) {
try { try {
return await execa.stdout('git', ['rev-list', '-1', tagName], execaOpts); return await execa.stdout('git', ['rev-list', '-1', tagName], execaOpts);
} catch (error) { } catch (error) {
@ -25,7 +25,7 @@ async function gitTagHead(tagName, execaOpts) {
* @return {Array<String>} List of git tags. * @return {Array<String>} List of git tags.
* @throws {Error} If the `git` command fails. * @throws {Error} If the `git` command fails.
*/ */
async function gitTags(execaOpts) { async function getTags(execaOpts) {
return (await execa.stdout('git', ['tag'], execaOpts)) return (await execa.stdout('git', ['tag'], execaOpts))
.split('\n') .split('\n')
.map(tag => tag.trim()) .map(tag => tag.trim())
@ -75,7 +75,7 @@ async function fetch(repositoryUrl, execaOpts) {
* *
* @return {string} the sha of the HEAD commit. * @return {string} the sha of the HEAD commit.
*/ */
function gitHead(execaOpts) { function getGitHead(execaOpts) {
return execa.stdout('git', ['rev-parse', 'HEAD'], execaOpts); return execa.stdout('git', ['rev-parse', 'HEAD'], execaOpts);
} }
@ -186,11 +186,11 @@ async function isBranchUpToDate(branch, execaOpts) {
} }
module.exports = { module.exports = {
gitTagHead, getTagHead,
gitTags, getTags,
isRefInHistory, isRefInHistory,
fetch, fetch,
gitHead, getGitHead,
repoUrl, repoUrl,
isGitRepo, isGitRepo,
verifyAuth, verifyAuth,

18
test/git.test.js
View File

@ -1,14 +1,14 @@
import test from 'ava'; import test from 'ava';
import tempy from 'tempy'; import tempy from 'tempy';
import { import {
gitTagHead, getTagHead,
isRefInHistory, isRefInHistory,
fetch, fetch,
gitHead, getGitHead,
repoUrl, repoUrl,
tag, tag,
push, push,
gitTags, getTags,
isGitRepo, isGitRepo,
verifyTagName, verifyTagName,
isBranchUpToDate, isBranchUpToDate,
@ -33,7 +33,7 @@ test('Get the last commit sha', async t => {
// Add commits to the master branch // Add commits to the master branch
const commits = await gitCommits(['First'], {cwd}); const commits = await gitCommits(['First'], {cwd});
const result = await gitHead({cwd}); const result = await getGitHead({cwd});
t.is(result, commits[0].hash); t.is(result, commits[0].hash);
}); });
@ -42,7 +42,7 @@ test('Throw error if the last commit sha cannot be found', 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 {cwd} = await gitRepo(); const {cwd} = await gitRepo();
await t.throws(gitHead({cwd}), Error); await t.throws(getGitHead({cwd}), Error);
}); });
test('Unshallow and fetch repository', async t => { test('Unshallow and fetch repository', async t => {
@ -84,7 +84,7 @@ test('Fetch all tags on a detached head repository', async t => {
await fetch(repositoryUrl, {cwd}); await fetch(repositoryUrl, {cwd});
t.deepEqual((await gitTags({cwd})).sort(), ['v1.0.0', 'v1.0.1', 'v1.1.0'].sort()); t.deepEqual((await getTags({cwd})).sort(), ['v1.0.0', 'v1.0.1', 'v1.1.0'].sort());
}); });
test('Verify if the commit `sha` is in the direct history of the current branch', async t => { test('Verify if the commit `sha` is in the direct history of the current branch', async t => {
@ -111,8 +111,8 @@ test('Get the commit sha for a given tag or falsy if the tag does not exists', a
// Create the tag corresponding to version 1.0.0 // Create the tag corresponding to version 1.0.0
await gitTagVersion('v1.0.0', undefined, {cwd}); await gitTagVersion('v1.0.0', undefined, {cwd});
t.is(await gitTagHead('v1.0.0', {cwd}), commits[0].hash); t.is(await getTagHead('v1.0.0', {cwd}), commits[0].hash);
t.falsy(await gitTagHead('missing_tag', {cwd})); t.falsy(await getTagHead('missing_tag', {cwd}));
}); });
test('Return git remote repository url from config', async t => { test('Return git remote repository url from config', async t => {
@ -192,7 +192,7 @@ test('Return falsy for invalid tag names', async t => {
test('Throws error if obtaining the tags fails', async t => { test('Throws error if obtaining the tags fails', async t => {
const cwd = tempy.directory(); const cwd = tempy.directory();
await t.throws(gitTags({cwd})); await t.throws(getTags({cwd}));
}); });
test('Return "true" if repository is up to date', async t => { test('Return "true" if repository is up to date', async t => {

72
test/integration.test.js
View File

@ -6,7 +6,7 @@ import {writeJson, readJson} from 'fs-extra';
import execa from 'execa'; import execa from 'execa';
import {WritableStreamBuffer} from 'stream-buffers'; import {WritableStreamBuffer} from 'stream-buffers';
import {SECRET_REPLACEMENT} from '../lib/definitions/constants'; import {SECRET_REPLACEMENT} from '../lib/definitions/constants';
import {gitHead as getGitHead, gitTagHead, gitRepo, gitCommits, gitRemoteTagHead, gitPush} from './helpers/git-utils'; import {gitHead, 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';
@ -108,12 +108,12 @@ test('Release patch, minor and major versions', async t => {
let [, releasedVersion, releasedGitHead] = /^version = '(.+)'\s+gitHead = '(.+)'$/.exec( let [, releasedVersion, releasedGitHead] = /^version = '(.+)'\s+gitHead = '(.+)'$/.exec(
(await execa('npm', ['show', packageName, 'version', 'gitHead'], {env: testEnv, cwd})).stdout (await execa('npm', ['show', packageName, 'version', 'gitHead'], {env: testEnv, cwd})).stdout
); );
let gitHead = await getGitHead({cwd}); let head = await gitHead({cwd});
t.is(releasedVersion, version); t.is(releasedVersion, version);
t.is(releasedGitHead, gitHead); t.is(releasedGitHead, head);
t.is(await gitTagHead(`v${version}`, {cwd}), gitHead); t.is(await gitTagHead(`v${version}`, {cwd}), head);
t.is(await gitRemoteTagHead(authUrl, `v${version}`, {cwd}), gitHead); t.is(await gitRemoteTagHead(authUrl, `v${version}`, {cwd}), head);
t.log(`+ released ${releasedVersion} with gitHead ${releasedGitHead}`); t.log(`+ released ${releasedVersion} with head ${releasedGitHead}`);
await mockServer.verify(verifyMock); await mockServer.verify(verifyMock);
await mockServer.verify(createReleaseMock); await mockServer.verify(createReleaseMock);
@ -150,12 +150,12 @@ test('Release patch, minor and major versions', async t => {
[, releasedVersion, releasedGitHead] = /^version = '(.+)'\s+gitHead = '(.+)'$/.exec( [, releasedVersion, releasedGitHead] = /^version = '(.+)'\s+gitHead = '(.+)'$/.exec(
(await execa('npm', ['show', packageName, 'version', 'gitHead'], {env: testEnv, cwd})).stdout (await execa('npm', ['show', packageName, 'version', 'gitHead'], {env: testEnv, cwd})).stdout
); );
gitHead = await getGitHead({cwd}); head = await gitHead({cwd});
t.is(releasedVersion, version); t.is(releasedVersion, version);
t.is(releasedGitHead, gitHead); t.is(releasedGitHead, head);
t.is(await gitTagHead(`v${version}`, {cwd}), gitHead); t.is(await gitTagHead(`v${version}`, {cwd}), head);
t.is(await gitRemoteTagHead(authUrl, `v${version}`, {cwd}), gitHead); t.is(await gitRemoteTagHead(authUrl, `v${version}`, {cwd}), head);
t.log(`+ released ${releasedVersion} with gitHead ${releasedGitHead}`); t.log(`+ released ${releasedVersion} with head ${releasedGitHead}`);
await mockServer.verify(verifyMock); await mockServer.verify(verifyMock);
await mockServer.verify(createReleaseMock); await mockServer.verify(createReleaseMock);
@ -192,12 +192,12 @@ test('Release patch, minor and major versions', async t => {
[, releasedVersion, releasedGitHead] = /^version = '(.+)'\s+gitHead = '(.+)'$/.exec( [, releasedVersion, releasedGitHead] = /^version = '(.+)'\s+gitHead = '(.+)'$/.exec(
(await execa('npm', ['show', packageName, 'version', 'gitHead'], {env: testEnv, cwd})).stdout (await execa('npm', ['show', packageName, 'version', 'gitHead'], {env: testEnv, cwd})).stdout
); );
gitHead = await getGitHead({cwd}); head = await gitHead({cwd});
t.is(releasedVersion, version); t.is(releasedVersion, version);
t.is(releasedGitHead, gitHead); t.is(releasedGitHead, head);
t.is(await gitTagHead(`v${version}`, {cwd}), gitHead); t.is(await gitTagHead(`v${version}`, {cwd}), head);
t.is(await gitRemoteTagHead(authUrl, `v${version}`, {cwd}), gitHead); t.is(await gitRemoteTagHead(authUrl, `v${version}`, {cwd}), head);
t.log(`+ released ${releasedVersion} with gitHead ${releasedGitHead}`); t.log(`+ released ${releasedVersion} with head ${releasedGitHead}`);
await mockServer.verify(verifyMock); await mockServer.verify(verifyMock);
await mockServer.verify(createReleaseMock); await mockServer.verify(createReleaseMock);
@ -234,12 +234,12 @@ test('Release patch, minor and major versions', async t => {
[, releasedVersion, releasedGitHead] = /^version = '(.+)'\s+gitHead = '(.+)'$/.exec( [, releasedVersion, releasedGitHead] = /^version = '(.+)'\s+gitHead = '(.+)'$/.exec(
(await execa('npm', ['show', packageName, 'version', 'gitHead'], {env: testEnv, cwd})).stdout (await execa('npm', ['show', packageName, 'version', 'gitHead'], {env: testEnv, cwd})).stdout
); );
gitHead = await getGitHead({cwd}); head = await gitHead({cwd});
t.is(releasedVersion, version); t.is(releasedVersion, version);
t.is(releasedGitHead, gitHead); t.is(releasedGitHead, head);
t.is(await gitTagHead(`v${version}`, {cwd}), gitHead); t.is(await gitTagHead(`v${version}`, {cwd}), head);
t.is(await gitRemoteTagHead(authUrl, `v${version}`, {cwd}), gitHead); t.is(await gitRemoteTagHead(authUrl, `v${version}`, {cwd}), head);
t.log(`+ released ${releasedVersion} with gitHead ${releasedGitHead}`); t.log(`+ released ${releasedVersion} with head ${releasedGitHead}`);
await mockServer.verify(verifyMock); await mockServer.verify(verifyMock);
await mockServer.verify(createReleaseMock); await mockServer.verify(createReleaseMock);
@ -388,12 +388,12 @@ test('Allow local releases with "noCi" option', async t => {
(await execa('npm', ['show', packageName, 'version', 'gitHead'], {env: testEnv, cwd})).stdout (await execa('npm', ['show', packageName, 'version', 'gitHead'], {env: testEnv, cwd})).stdout
); );
const gitHead = await getGitHead({cwd}); const head = await gitHead({cwd});
t.is(releasedVersion, version); t.is(releasedVersion, version);
t.is(releasedGitHead, gitHead); t.is(releasedGitHead, head);
t.is(await gitTagHead(`v${version}`, {cwd}), gitHead); t.is(await gitTagHead(`v${version}`, {cwd}), head);
t.is(await gitRemoteTagHead(authUrl, `v${version}`, {cwd}), gitHead); t.is(await gitRemoteTagHead(authUrl, `v${version}`, {cwd}), head);
t.log(`+ released ${releasedVersion} with gitHead ${releasedGitHead}`); t.log(`+ released ${releasedVersion} with head ${releasedGitHead}`);
await mockServer.verify(verifyMock); await mockServer.verify(verifyMock);
await mockServer.verify(createReleaseMock); await mockServer.verify(createReleaseMock);
@ -442,12 +442,12 @@ test('Pass options via CLI arguments', async t => {
const [, releasedVersion, releasedGitHead] = /^version = '(.+)'\s+gitHead = '(.+)'$/.exec( const [, releasedVersion, releasedGitHead] = /^version = '(.+)'\s+gitHead = '(.+)'$/.exec(
(await execa('npm', ['show', packageName, 'version', 'gitHead'], {env: testEnv, cwd})).stdout (await execa('npm', ['show', packageName, 'version', 'gitHead'], {env: testEnv, cwd})).stdout
); );
const gitHead = await getGitHead({cwd}); const head = await gitHead({cwd});
t.is(releasedVersion, version); t.is(releasedVersion, version);
t.is(releasedGitHead, gitHead); t.is(releasedGitHead, head);
t.is(await gitTagHead(`v${version}`, {cwd}), gitHead); t.is(await gitTagHead(`v${version}`, {cwd}), head);
t.is(await gitRemoteTagHead(authUrl, `v${version}`, {cwd}), gitHead); t.is(await gitRemoteTagHead(authUrl, `v${version}`, {cwd}), head);
t.log(`+ released ${releasedVersion} with gitHead ${releasedGitHead}`); t.log(`+ released ${releasedVersion} with head ${releasedGitHead}`);
}); });
test('Run via JS API', async t => { test('Run via JS API', async t => {
@ -500,12 +500,12 @@ test('Run via JS API', async t => {
const [, releasedVersion, releasedGitHead] = /^version = '(.+)'\s+gitHead = '(.+)'$/.exec( const [, releasedVersion, releasedGitHead] = /^version = '(.+)'\s+gitHead = '(.+)'$/.exec(
(await execa('npm', ['show', packageName, 'version', 'gitHead'], {env: testEnv, cwd})).stdout (await execa('npm', ['show', packageName, 'version', 'gitHead'], {env: testEnv, cwd})).stdout
); );
const gitHead = await getGitHead({cwd}); const head = await gitHead({cwd});
t.is(releasedVersion, version); t.is(releasedVersion, version);
t.is(releasedGitHead, gitHead); t.is(releasedGitHead, head);
t.is(await gitTagHead(`v${version}`, {cwd}), gitHead); t.is(await gitTagHead(`v${version}`, {cwd}), head);
t.is(await gitRemoteTagHead(authUrl, `v${version}`, {cwd}), gitHead); t.is(await gitRemoteTagHead(authUrl, `v${version}`, {cwd}), head);
t.log(`+ released ${releasedVersion} with gitHead ${releasedGitHead}`); t.log(`+ released ${releasedVersion} with head ${releasedGitHead}`);
await mockServer.verify(verifyMock); await mockServer.verify(verifyMock);
await mockServer.verify(createReleaseMock); await mockServer.verify(createReleaseMock);