etcher/lib/shared/release.js
Juan Cruz Viotti 5196ac8d32 refactor: simplify release type handling within the app (#1667)
As another step towards moving to GitHub Releases, this commit makes the
application care much less about the actual release type of the current
version, instead checking if the application is stable or not, which is
more aligned to what GitHub provides us.

Signed-off-by: Juan Cruz Viotti <jv@jviotti.com>
2017-08-09 08:43:19 -07:00

108 lines
2.5 KiB
JavaScript

/*
* Copyright 2017 resin.io
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
'use strict'
const _ = require('lodash')
const semver = require('semver')
/**
* @summary Application release types
* @namespace RELEASE_TYPE
* @public
*/
exports.RELEASE_TYPE = {
/**
* @property {String} PRODUCTION
* @memberof RELEASE_TYPE
* @description
* Production release type
*/
PRODUCTION: 'PRODUCTION',
/**
* @property {String} SNAPSHOT
* @memberof RELEASE_TYPE
* @description
* Snapshot release type
*/
SNAPSHOT: 'SNAPSHOT',
/**
* @property {String} UNKNOWN
* @memberof RELEASE_TYPE
* @description
* Unknown release type
*/
UNKNOWN: 'UNKNOWN'
}
/**
* @summary Get the release type from a version string
* @function
* @public
*
* @param {String} version - application version
* @returns {RELEASE_TYPE} release type
*
* @example
* const version = require('../../package.json').version;
* const releaseType = release.getReleaseType(version);
*
* if (releaseType === release.RELEASE_TYPE.PRODUCTION) {
* console.log('This is a production release!');
* }
*/
exports.getReleaseType = (version) => {
const GIT_HASH_REGEX = /^[0-9a-f]{7,40}$/
const buildNumber = _.get(semver.parse(version), [ 'build' ])
if (!_.isNil(buildNumber)) {
if (_.isEmpty(buildNumber)) {
return exports.RELEASE_TYPE.PRODUCTION
}
if (GIT_HASH_REGEX.test(_.first(buildNumber))) {
return exports.RELEASE_TYPE.SNAPSHOT
}
}
return exports.RELEASE_TYPE.UNKNOWN
}
/**
* @summary Check if a version is a stable release
* @function
* @public
*
* @param {String} version - version
* @returns {Boolean} whether the version is a stable release
*
* @example
* if (release.isStableRelease('1.0.0')) {
* console.log('This is a stable release');
* }
*/
exports.isStableRelease = (version) => {
const parsedVersion = semver.parse(version)
return _.every([
_.isEmpty(_.get(parsedVersion, [ 'prerelease' ])),
_.isEmpty(_.get(parsedVersion, [ 'build' ]))
])
}