New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
github-release-notes
Advanced tools
github-release-notes - npm Package Compare versions
Comparing version 0.1.0 to 0.2.0
| 'use strict'; | ||
| var Github = require('github-api'); | ||
| var options = getOptions(process.argv); | ||
| var token = options.token; | ||
| var username = options.username; | ||
| var repositoryName = options.repo; | ||
| var releasePrefix = options.prefix || ''; | ||
| var github = new Github({ | ||
| token: token, | ||
| auth: "oauth" | ||
| }); | ||
| var repo = github.getRepo(username, repositoryName); | ||
| /** | ||
| * Create a literal object of the node module options | ||
| * | ||
| * @param {Array} args The array of arguments (the module arguments start from index 2) | ||
| * | ||
| * @return {Object} The object containg the key/value options | ||
| */ | ||
| function getOptions(args) { | ||
| var settings = {}; | ||
| for(var i=2;i<args.length;i++) { | ||
| settings[args[i].split('=')[0].replace('--', '')] = args[i].split('=')[1]; | ||
| } | ||
| return settings; | ||
| } | ||
| /** | ||
| * Create a release from a given tag (in the options) | ||
| * | ||
| * @param {Object} options The options to build the release: | ||
| * { | ||
| * "tag_name": "v1.0.0", | ||
| * "target_commitish": "master", | ||
| * "name": "v1.0.0", | ||
| * "body": "Description of the release", | ||
| * "draft": false, | ||
| * "prerelease": false | ||
| * } | ||
| */ | ||
| function makeRelease(releaseOptions) { | ||
| repo.makeRelease(releaseOptions, function (err, release) { | ||
| if(err) { | ||
| console.error( | ||
| (JSON.parse(err.request.responseText)).message + '\n' | ||
| + (JSON.parse(err.request.responseText)).errors[0].code | ||
| ); | ||
| } else { | ||
| console.info(release.tag_name + ' successfully created!'); | ||
| } | ||
| }); | ||
| } | ||
| /** | ||
| * Return a string with a - to be a bullet list (used for a mapping) | ||
| * | ||
| * @param {string} message | ||
| * | ||
| * @return {string} | ||
| */ | ||
| function createBody(message) { | ||
| return '- ' + message; | ||
| } | ||
| /** | ||
| * Transforms the commits to commit messages | ||
| * | ||
| * @param {[Object]} commits The array of object containing the commits | ||
| * | ||
| * @return {[string]} | ||
| */ | ||
| function commitMessages(commits) { | ||
| return commits.map(function (commit) { | ||
| return commit.commit.message; | ||
| }); | ||
| } | ||
| /** | ||
| * Creates the options to make the release | ||
| * | ||
| * @param {[string]} commitMessages The commit messages to create the release body | ||
| */ | ||
| function prepareRelease(tags, commitMessages) { | ||
| commitMessages.pop(); | ||
| var body = commitMessages.filter(function (message) { | ||
| return !message.match('Merge'); | ||
| }).map(createBody); | ||
| var releaseOptions = { | ||
| tag_name: tags[0].name, | ||
| name: releasePrefix + tags[0].name, | ||
| body: body.join('\n'), | ||
| draft: options.draft || false, | ||
| prerelease: options.prerelease || false | ||
| }; | ||
| makeRelease(releaseOptions); | ||
| } | ||
| /** | ||
| * Gets all the commits between two dates | ||
| * | ||
| * @param {string} since The since date in ISO | ||
| * @param {string} until The until date in ISO | ||
| * | ||
| * @return {Promise} The promise which resolves the [Array] commit messages | ||
| */ | ||
| function getCommitsBetweenTwo(since, until) { | ||
| var options = { | ||
| since: since, | ||
| until: until | ||
| }; | ||
| return new Promise(function (resolve, reject) { | ||
| repo.getCommits(options, function (err, commits) { | ||
| if(err) { | ||
| reject(err); | ||
| } else { | ||
| resolve(commitMessages(commits)); | ||
| } | ||
| }); | ||
| }); | ||
| } | ||
| /** | ||
| * Get the dates of the last two tags | ||
| * | ||
| * @param {[Object]} tags List of all the tags in the repo | ||
| * @return {[Promise]} The promises which returns the dates | ||
| */ | ||
| function getTagDates(lastTag, lastRelease) { | ||
| return [lastTag, lastRelease].map(function (tag) { | ||
| return new Promise(function (resolve, reject) { | ||
| repo.getCommit('master', tag.commit.sha, function (err, commit) { | ||
| if(err) { | ||
| reject(err); | ||
| } else { | ||
| resolve(commit.committer.date); | ||
| } | ||
| }); | ||
| }); | ||
| }) | ||
| } | ||
| /** | ||
| * Get all the tags of the repo | ||
| * | ||
| * @return {Promise} | ||
| */ | ||
| function getLastTag(releaseTagName) { | ||
| return new Promise(function (resolve, reject) { | ||
| repo.listTags(function (err, tags) { | ||
| if(err) { | ||
| reject(err); | ||
| } else { | ||
| resolve( | ||
| tags.filter(function(tag, index) { | ||
| return (index === 0 || tag.name === releaseTagName); | ||
| }) | ||
| ); | ||
| } | ||
| }); | ||
| }); | ||
| } | ||
| /** | ||
| * Get the latest release | ||
| * | ||
| * @return {Promise} The promise which resolves the tag name of the release | ||
| */ | ||
| function getLatestRelease() { | ||
| return new Promise(function (resolve, reject) { | ||
| repo.getLatestRelease(function (err, release) { | ||
| if(err) { | ||
| reject(err); | ||
| } else { | ||
| resolve(release.tag_name); | ||
| } | ||
| }); | ||
| }); | ||
| } | ||
| /** | ||
| * Get All the tags, get the dates, get the commits between those dates and prepeare the release | ||
| */ | ||
| function init() { | ||
| getLatestRelease().then(function (releaseTagName) { | ||
| getLastTag(releaseTagName).then(function (tags) { | ||
| if(tags.length === 1) { | ||
| console.error('The latest tag is the latest release!'); | ||
| return; | ||
| } | ||
| Promise.all(getTagDates(tags[0], tags[1])) | ||
| .then(function (data) { | ||
| getCommitsBetweenTwo(data[1], data[0]).then(prepareRelease.bind(null, tags)); | ||
| }); | ||
| }); | ||
| }); | ||
| } | ||
| init(); | ||
| var githubReleaseNotes = require('./lib/index'); |
| { | ||
| "name": "github-release-notes", | ||
| "version": "0.1.0", | ||
| "version": "0.2.0", | ||
| "description": "Node module to publish release notes based on commits between the last two tags.", | ||
| "main": "github-release-notes.js", | ||
| "main": "./src/index.js", | ||
| "scripts": { | ||
| "start": "node github-release-notes.js", | ||
| "test": "echo \"Error: no test specified\" && exit 1" | ||
@@ -8,0 +9,0 @@ }, |
| # github-release-notes | ||
| [](https://badge.fury.io/js/github-release-notes) | ||
| Node module which generates a release from the latest tag and compiles release notes based on commit messages between the last tag and the latest release. | ||
@@ -3,0 +6,0 @@ |
New alerts
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by14.25%
7711
- Number of package files
- increased by25%
5
- Lines of code
- increased by10.16%
206
- Number of lines in readme file
- increased by10.34%
32
Worsened metrics
- Number of medium supply chain risk alerts
- increased byInfinity%
1
No dependency changes