Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[BUGFIX] Centralize build versioning info
Make BUILD_TYPE only affect published buildType if on master so we don't accidentally publish from lts/release branches over the current beta or release. Only use a tag as version if it is parseable by semver. The build-for-publishing script uses git info instead of travis env.
- Loading branch information
1 parent
14cb285
commit bd0e1a3
Showing
6 changed files
with
360 additions
and
53 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,162 @@ | ||
| 'use strict'; | ||
| const fs = require('fs'); | ||
| const path = require('path'); | ||
| const gitRepoInfo = require('git-repo-info'); | ||
| const semver = require('semver'); | ||
|
|
||
| const NON_SEMVER_IDENTIFIER = /[^0-9A-Za-z-]/g; | ||
|
|
||
| /** @type {BuildInfo} */ | ||
| let cached; | ||
|
|
||
| /** | ||
| * @param {Options=} options | ||
| * @returns {BuildInfo} | ||
| */ | ||
| function buildInfo(options) { | ||
| if (!options && cached) { | ||
| return cached; | ||
| } | ||
| let root = (options && options.root) || path.resolve(__dirname, '..'); | ||
| let packageVersion = (options && options.packageVersion) || readPackageVersion(root); | ||
| let gitInfo = (options && options.gitInfo) || buildGitInfo(root); | ||
| let buildInfo = buildFromParts(packageVersion, gitInfo); | ||
| if (!options) { | ||
| cached = buildInfo; | ||
| } | ||
| return buildInfo; | ||
| } | ||
|
|
||
| /** | ||
| * @param {string} root | ||
| * @returns {GitInfo} | ||
| */ | ||
| function buildGitInfo(root) { | ||
| let info = gitRepoInfo(root); | ||
| return { | ||
| sha: process.env.TRAVIS_COMMIT || info.sha, | ||
| branch: process.env.TRAVIS_BRANCH || info.branch, | ||
| tag: process.env.TRAVIS_TAG || info.tag, | ||
| }; | ||
| } | ||
|
|
||
| /** | ||
| * @typedef {Object} GitInfo | ||
| * @property {string} sha | ||
| * @property {string=} branch | ||
| * @property {string=} tag | ||
| */ | ||
|
|
||
| /** | ||
| * @typedef {Object} Options | ||
| * @property {string=} root | ||
| * @property {string=} packageVersion | ||
| * @property {GitInfo=} gitInfo | ||
| */ | ||
|
|
||
| /** | ||
| * @typedef {Object} BuildInfo | ||
| * @property {string=} tag | ||
| * @property {string=} branch | ||
| * @property {string} sha | ||
| * @property {string} shortSha | ||
| * @property {string=} channel | ||
| * @property {string} packageVersion | ||
| * @property {string=} tagVersion | ||
| * @property {string} version | ||
| */ | ||
|
|
||
| /** | ||
| * Build info object from parts. | ||
| * @param {string} packageVersion | ||
| * @param {GitInfo} gitInfo | ||
| * @returns {BuildInfo} | ||
| */ | ||
| function buildFromParts(packageVersion, gitInfo) { | ||
| // Travis builds are always detached | ||
| let { tag, branch, sha } = gitInfo; | ||
|
|
||
| let tagVersion = parseTagVersion(tag); | ||
| let shortSha = sha.slice(0, 8); | ||
| let channel = | ||
| branch === 'master' | ||
| ? process.env.BUILD_TYPE === 'alpha' ? 'alpha' : 'canary' | ||
| : branch && escapeSemVerIdentifier(branch); | ||
| let version = tagVersion || buildVersion(packageVersion, shortSha, channel); | ||
|
|
||
| return { | ||
| tag, | ||
| branch, | ||
| sha, | ||
| shortSha, | ||
| channel, | ||
| packageVersion, | ||
| tagVersion, | ||
| version, | ||
| }; | ||
| } | ||
|
|
||
| /** | ||
| * Read package version. | ||
| * @param {string} root | ||
| * @returns {string} | ||
| */ | ||
| function readPackageVersion(root) { | ||
| let pkg = JSON.parse(fs.readFileSync(path.join(root, 'package.json'), 'utf8')); | ||
| // use _originalVersion if present if we've already mutated it | ||
| return pkg._originalVersion || pkg.version; | ||
| } | ||
|
|
||
| /** | ||
| * @param {string} tag | ||
| */ | ||
| function parseTagVersion(tag) { | ||
| try { | ||
| return tag && semver.parse(tag).version; | ||
| } catch (e) { | ||
| return; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @param {string} txt | ||
| */ | ||
| function escapeSemVerIdentifier(txt) { | ||
| return txt.replace(NON_SEMVER_IDENTIFIER, '-'); | ||
| } | ||
|
|
||
| /** | ||
| * @param {string} packageVersion | ||
| * @param {string} sha | ||
| * @param {string=} channel | ||
| */ | ||
| function buildVersion(packageVersion, sha, channel) { | ||
| let base = semver.parse(packageVersion); | ||
| let major = base.major; | ||
| let minor = base.minor; | ||
| let patch = base.patch; | ||
| let suffix = ''; | ||
| suffix += toSuffix('-', base.prerelease, channel); | ||
| suffix += toSuffix('+', base.build, sha); | ||
| return `${major}.${minor}.${patch}${suffix}`; | ||
| } | ||
|
|
||
| /** | ||
| * @param {string} delim | ||
| * @param {string[]} identifiers | ||
| * @param {string=} identifier | ||
| */ | ||
| function toSuffix(delim, identifiers, identifier) { | ||
| if (identifier) { | ||
| identifiers = identifiers.concat([identifier]); | ||
| } | ||
| if (identifiers.length > 0) { | ||
| return delim + identifiers.join('.'); | ||
| } | ||
| return ''; | ||
| } | ||
|
|
||
| module.exports.buildInfo = buildInfo; | ||
| module.exports.buildFromParts = buildFromParts; | ||
| module.exports.buildVersion = buildVersion; | ||
| module.exports.parseTagVersion = parseTagVersion; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,36 +1,5 @@ | ||
| 'use strict'; | ||
|
|
||
| const getGitInfo = require('git-repo-info'); | ||
| const path = require('path'); | ||
| const buildInfo = require('../broccoli/build-info').buildInfo(); | ||
|
|
||
| module.exports.VERSION = (() => { | ||
| let info = getGitInfo(path.resolve(__dirname, '..')); | ||
| // if the current commit _is_ a tagged commit, use the tag as the version | ||
| // number | ||
| if (info.tag) { | ||
| return info.tag.replace(/^v/, ''); | ||
| } | ||
|
|
||
| let pkg = require('../package'); | ||
| // if `_versionPreviouslyCalculated` is set the `package.json` version string | ||
| // _already_ includes the branch, sha, etc (from bin/build-for-publishing.js) | ||
| // so just use it directly | ||
| if (pkg._versionPreviouslyCalculated) { | ||
| return pkg.version; | ||
| } | ||
|
|
||
| // otherwise build the version number up of: | ||
| // | ||
| // * actual package.json version string | ||
| // * current "build type" or branch name (in CI this is generally not | ||
| // present, but it is very useful for local / testing builds) | ||
| // * the sha for the commit | ||
| let packageVersion = pkg.version; | ||
| let sha = info.sha || ''; | ||
| let suffix = process.env.BUILD_TYPE || info.branch; | ||
| // * remove illegal non-alphanumeric characters from branch name. | ||
| suffix = suffix && suffix.replace(/[^a-zA-Z\d\s-]/g, '-'); | ||
| let metadata = sha.slice(0, 8); | ||
|
|
||
| return `${packageVersion}${suffix ? '-' + suffix : ''}+${metadata}`; | ||
| })(); | ||
| module.exports.VERSION = buildInfo.version; |
Oops, something went wrong.