skills/angular__angular
1
0
Fork 0
mirror of https://github.com/angular/angular.git synced 2026-09-14 13:54:52 +08:00
Code Issues Packages Projects Releases Wiki Activity

chore(changelog): properly name tags for github compare links (#971)

Browse Source 
* chore(changelog): properly name tags for github compare links

* The convention changelog currently auto-prefixes the previous semver tag with a `v`, which causes the github compare links to not work.
* Manually resolve the previous and current tag from the git metadata. (As in https://github.com/angular/material/pull/9264)

* Remove prefixed compare links in previous generated chaneglog

* Change `getTags` to `getAvailableTags`

* Add comment explaining how we resolve the tags
This commit is contained in:
Paul Gschwendtner
2016-08-10 20:26:12 +02:00
committed by Jeremy Elbourn
parent 7f594ce206
commit ab5f9533d0
2 changed files with 38 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
scripts/release/changelog.js
+31 -7
View File
@@ -1,20 +1,31 @@
#!/usr/bin/env node
'use strict';
/**
/*
* Creates a conventional changelog from the current git repository / metadata.
*/
var fs = require('fs');
var addStream = require('add-stream');
var cl = require('conventional-changelog');
var inStream = fs.createReadStream('CHANGELOG.md');
const fs = require('fs');
const addStream = require('add-stream');
const changelog = require('conventional-changelog');
const spawnSync = require('child_process').spawnSync;
const npmVersion = require('../../package.json').version;
/**
* When the command line argument `--force` is provided, then the full changelog will created and overwritten.
* By default, it will only create the changelog from the latest tag to head and prepends it to the changelog.
*/
var isForce = process.argv.indexOf('--force') !== -1;
const isForce = process.argv.indexOf('--force') !== -1;
const inStream = fs.createReadStream('CHANGELOG.md');
const gitTags = getAvailableTags();
// Whether the npm version is later than the most recent tag.
const isNpmLatest = npmVersion !== gitTags[0];
// When the npm version is the latest, use the npm version, otherwise use the latest tag.
const currentTag = isNpmLatest ? npmVersion : gitTags[0];
// When the npm version is the latest use the most recent tag. Otherwise use the previous tag.
const previousTag = isNpmLatest ? gitTags[0] : gitTags[1];
inStream.on('error', function(err) {
console.error('An error occurred, while reading the previous changelog file.\n' +
@@ -28,7 +39,12 @@ var config = {
releaseCount: isForce ? 0 : 1
};
var stream = cl(config)
var context = {
currentTag: currentTag,
previousTag: previousTag
};
var stream = changelog(config, context)
.on('error', function(err) {
console.error('An error occurred while generating the changelog: ' + err);
})
@@ -45,3 +61,11 @@ if (!isForce) {
function getOutputStream() {
return fs.createWriteStream('CHANGELOG.md');
}
/**
* Resolves available tags over all branches from the repository metadata.
* @returns {Array.<String>} Array of available tags.
*/
function getAvailableTags() {
return spawnSync('git', ['tag']).stdout.toString().trim().split('\n').reverse();
}