supernets/hardlounge
supernets/hardlounge
4
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #1914 from thelounge/astorije/changelog-prerelease-wording

Browse Source 
Separate and improve wording for `pre` and `rc` pre-release versions
This commit is contained in:
Jérémie Astori 2018-01-01 20:37:29 -05:00 committed by GitHub
commit 068b842561
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
scripts/changelog.js
View File

@ -93,7 +93,14 @@ function prereleaseTemplate(items) {
[See the full changelog](${items.fullChangelogUrl}) [See the full changelog](${items.fullChangelogUrl})
This is a release candidate for v${stableVersion(items.version)} to ensure maximum stability for public release. ${prereleaseType(items.version) === "rc" ?
`This is a release candidate (RC) for v${stableVersion(items.version)} to ensure maximum stability for public release.
Bugs may be fixed, but no further features will be added until the next stable version.` :
`This is a pre-release for v${stableVersion(items.version)} to offer latest changes without having to wait for a stable release.
At this stage, features may still be added or modified until the first release candidate for this version gets released.`
}
Please refer to the commit list given above for a complete list of changes, or wait for the stable release to get a thoroughly prepared change log entry. Please refer to the commit list given above for a complete list of changes, or wait for the stable release to get a thoroughly prepared change log entry.
As with all pre-releases, this version requires explicit use of the \`next\` tag to be installed: As with all pre-releases, this version requires explicit use of the \`next\` tag to be installed:
@ -170,6 +177,11 @@ function isPrerelease(v) {
return v.includes("-"); return v.includes("-");
} }
// Given a version of `x.y.z-abc.n`, returns `abc`, i.e. the type of pre-release
function prereleaseType(v) {
return semver.prerelease(v)[0];
}
// Returns the stable version that this pre-release version is targeting. For // Returns the stable version that this pre-release version is targeting. For
// example, if new version is 2.5.0-rc.2, next stable version will be 2.5.0. // example, if new version is 2.5.0-rc.2, next stable version will be 2.5.0.
function stableVersion(prereleaseVersion) { function stableVersion(prereleaseVersion) {