From 2b949ced04e1e320e405049831b8d35e7b49853d Mon Sep 17 00:00:00 2001 From: Ralph Meier Date: Fri, 16 Nov 2018 10:30:40 +0100 Subject: [PATCH] feat: implement the first version of create-bump-pr --- .eslintrc.json | 203 +++++++++++++++++++++++++++++++++++++++++++++++++ .gitignore | 2 + .npmrc | 1 + .travis.yml | 16 ++++ LICENSE | 21 +++++ README.md | 19 ++++- cli.js | 17 +++++ index.js | 76 ++++++++++++++++++ octokit.js | 65 ++++++++++++++++ package.json | 34 +++++++++ 10 files changed, 452 insertions(+), 2 deletions(-) create mode 100644 .eslintrc.json create mode 100644 .gitignore create mode 100644 .npmrc create mode 100644 .travis.yml create mode 100644 LICENSE create mode 100644 cli.js create mode 100644 index.js create mode 100644 octokit.js create mode 100644 package.json diff --git a/.eslintrc.json b/.eslintrc.json new file mode 100644 index 0000000..188f289 --- /dev/null +++ b/.eslintrc.json @@ -0,0 +1,203 @@ +{ + "parserOptions": { + "ecmaVersion": 8, + "ecmaFeatures": { + "experimentalObjectRestSpread": true, + "jsx": true + }, + "sourceType": "module" + }, + + "env": { + "es6": true, + "node": true, + "mocha": true + }, + + "plugins": [], + + "globals": { + "cy": true, + "Cypress": true, + "document": false, + "navigator": false, + "window": false, + "expect": true, + "test": true, + "sinon": true, + "angular": true, + "inject": true + }, + + "rules": { + "accessor-pairs": 2, + "arrow-spacing": [2, {"before": true, "after": true}], + "block-spacing": [2, "always"], + "brace-style": [2, "1tbs", {"allowSingleLine": true}], + "camelcase": [2, {"properties": "never"}], + "comma-dangle": [2, "never"], + "comma-spacing": [2, {"before": false, "after": true}], + "comma-style": [2, "last"], + "computed-property-spacing": [2, "never"], + "constructor-super": 2, + "curly": [2, "multi-line"], + "dot-location": [2, "property"], + "eol-last": [2, "always"], + "eqeqeq": [2, "allow-null"], + "func-call-spacing": [2, "never"], + "callback-return": [1, ["callback", "cb", "done"]], + "handle-callback-err": [2, "^(err|error)$"], + "indent": [2, 2, { + "SwitchCase": 1, + "VariableDeclarator": 1, + "outerIIFEBody": 1, + "FunctionDeclaration": { + "parameters": 1, + "body": 1 + }, + "FunctionExpression": { + "parameters": 1, + "body": 1 + } + }], + "key-spacing": [2, {"beforeColon": false, "afterColon": true}], + "keyword-spacing": [2, {"before": true, "after": true}], + "linebreak-style": [2, "unix"], + "max-len": ["error", { + "code": 100, + "ignoreRegExpLiterals": true, + "ignorePattern": "\\s+require\\(|https?://" + }], + "new-cap": [2, {"newIsCap": true, "capIsNew": false}], + "new-parens": 2, + "newline-per-chained-call": [2, {"ignoreChainWithDepth": 4}], + "no-array-constructor": 2, + "no-caller": 2, + "no-class-assign": 2, + "no-cond-assign": 2, + "no-console": [1, {"allow": ["error"]}], + "no-const-assign": 2, + "no-constant-condition": [2, {"checkLoops": false}], + "no-control-regex": 2, + "no-debugger": 2, + "no-delete-var": 2, + "no-dupe-args": 2, + "no-dupe-class-members": 2, + "no-dupe-keys": 2, + "no-duplicate-case": 2, + "no-duplicate-imports": 2, + "no-empty-character-class": 2, + "no-empty-pattern": 2, + "no-eval": 2, + "no-ex-assign": 2, + "no-extend-native": 2, + "no-extra-bind": 2, + "no-extra-boolean-cast": 2, + "no-extra-parens": [2, "functions"], + "no-fallthrough": 2, + "no-floating-decimal": 2, + "no-func-assign": 2, + "no-global-assign": 2, + "no-implied-eval": 2, + "no-inner-declarations": [2, "functions"], + "no-invalid-regexp": 2, + "no-irregular-whitespace": 2, + "no-iterator": 2, + "no-label-var": 2, + "no-labels": [2, {"allowLoop": false, "allowSwitch": false}], + "no-lone-blocks": 2, + "no-lonely-if": 2, + "no-mixed-operators": [2, { + "groups": [ + ["+", "-", "*", "/", "%", "**"], + ["&", "|", "^", "~", "<<", ">>", ">>>"], + ["==", "!=", "===", "!==", ">", ">=", "<", "<="], + ["&&", "||"], + ["in", "instanceof"] + ], + "allowSamePrecedence": false + }], + "no-mixed-spaces-and-tabs": 2, + "no-multi-spaces": 2, + "no-multi-str": 2, + "no-multiple-empty-lines": [2, {"max": 2}], + "no-native-reassign": 2, + "no-negated-in-lhs": 2, + "no-nested-ternary": 2, + "no-new": 2, + "no-new-func": 2, + "no-new-object": 2, + "no-new-require": 2, + "no-new-symbol": 2, + "no-new-wrappers": 2, + "no-obj-calls": 2, + "no-octal": 2, + "no-octal-escape": 2, + "no-path-concat": 2, + "no-proto": 2, + "no-redeclare": 2, + "no-regex-spaces": 2, + "no-return-assign": [2, "except-parens"], + "no-self-assign": 2, + "no-self-compare": 2, + "no-sequences": 2, + "no-shadow-restricted-names": 2, + "no-shadow": ["error", { "allow": [ + "argv", + "callback", + "cb", + "done", + "err", + "params" + ] }], + "no-sparse-arrays": 2, + "no-tabs": 2, + "no-template-curly-in-string": 2, + "no-this-before-super": 2, + "no-throw-literal": 2, + "no-trailing-spaces": 2, + "no-undef": 2, + "no-undef-init": 2, + "no-unexpected-multiline": 2, + "no-unmodified-loop-condition": 2, + "no-unneeded-ternary": [2, {"defaultAssignment": false}], + "no-unreachable": 2, + "no-unsafe-finally": 2, + "no-unsafe-negation": 2, + "no-unused-vars": [2, {"vars": "all", "args": "none"}], + "no-useless-call": 2, + "no-useless-computed-key": 2, + "no-useless-constructor": 2, + "no-useless-escape": 2, + "no-useless-rename": 2, + "no-var": 2, + "no-whitespace-before-property": 2, + "no-with": 2, + "object-curly-spacing": [2, "never"], + "object-property-newline": [2, {"allowMultiplePropertiesPerLine": true}], + "one-var": [2, {"initialized": "never"}], + "operator-linebreak": [2, "after", {"overrides": {"?": "before", ":": "before"}}], + "padded-blocks": [0, "never"], + "prefer-template": 2, + "prefer-const": [2, {"destructuring": "any", "ignoreReadBeforeAssign": true}], + "quotes": [2, "single", {"avoidEscape": true, "allowTemplateLiterals": true}], + "rest-spread-spacing": [2, "never"], + "semi": [2, "never"], + "semi-spacing": [2, {"before": false, "after": true}], + "space-before-blocks": [2, "always"], + "space-before-function-paren": [2, "always"], + "space-in-parens": [2, "never"], + "space-infix-ops": 2, + "space-unary-ops": [2, {"words": true, "nonwords": false}], + "spaced-comment": [2, "always", + {"line": {"markers": ["*package", "!", ","]}, "block": {"balanced": true, "markers": ["*package", "!", ","], "exceptions": ["*"]}} + ], + "template-curly-spacing": [2, "never"], + "unicode-bom": [2, "never"], + "use-isnan": 2, + "valid-typeof": 2, + "wrap-iife": [2, "any", {"functionPrototypeMethods": true}], + "yield-star-spacing": [2, "both"], + "yoda": [2, "never"] + } +} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d5f19d8 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +node_modules +package-lock.json diff --git a/.npmrc b/.npmrc new file mode 100644 index 0000000..43c97e7 --- /dev/null +++ b/.npmrc @@ -0,0 +1 @@ +package-lock=false diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..3dcc4ed --- /dev/null +++ b/.travis.yml @@ -0,0 +1,16 @@ +language: node_js +cache: + directories: + - ~/.npm +notifications: + email: false +node_js: + - '10' + - '9' + - '8' + - '6' +after_success: + - npm run travis-deploy-once "npm run semantic-release" +branches: + except: + - /^v\d+\.\d+\.\d+$/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..c95a7c8 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2018 Ralph Meier + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 6b007e8..4cd7c60 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,17 @@ -# create-bump-pr -A simple helper to create a semantic-release bump pr +# Description + +A simple CLI command to create a semantic-release minor bump pull request. + +#### Workflow +- take the latest tag in your repository +- update your README.md with an empty line +- create a minor version bump pull-request to incite a new minor version + + +# Example + +### via CLI + +```bash +npx create-bump-pr --token= --owner= --repo= +``` diff --git a/cli.js b/cli.js new file mode 100644 index 0000000..2dec334 --- /dev/null +++ b/cli.js @@ -0,0 +1,17 @@ +#!/usr/bin/env node + +const argv = require('yargs') + .usage('Usage: $0 --token [string] --o [string]') + .demandOption(['token', 'owner', 'repo', 'base-branch']) + .argv +const run = require('./index') +const {token, owner, repo, baseBranch} = argv + +run({token, owner, repo, baseBranch}) + .then((pullRequest) => { + console.log(`The PR for the release-management bump has been opened at + ${pullRequest.data.html_url}`) + }) + .catch((e) => { + console.log(e.message) + }) diff --git a/index.js b/index.js new file mode 100644 index 0000000..363a3b0 --- /dev/null +++ b/index.js @@ -0,0 +1,76 @@ +const _ = require('lodash') +const semver = require('semver') +const Octokit = require('./octokit') + +// @return {'tag': '1.0.1', 'sha': '1234'} +const getHighestTag = async ({repo, owner, o}) => { + const tagsRaw = await o.getTagsByPage({repo, owner, page: 1, perPage: 5}) + return _ + .chain(tagsRaw.data) + .map((tag) => { + return { + 'tag': tag.name, + 'sha': tag.commit.sha + } + }) + .reduce((biggest, tag) => { + if (semver.valid(tag.tag) && semver.gte(tag.tag, biggest.tag)) { + return tag + } + return biggest + }, {'tag': '0.0.1', 'sha': '0000'}) + .value() +} + +const getNextMinorTag = ({tag}) => { + return semver.inc(tag, 'minor') +} + +// main application +module.exports = async ({owner, repo, token}) => { + const o = new Octokit(token) + + const baseTagCommit = await getHighestTag({repo, owner, o}) + const bumpTo = getNextMinorTag({tag: baseTagCommit.tag}) + + // get README.md + const readmeBase64 = await o.getReadme({owner, repo}) + + // add an empty line to the readme to have a code diff for the upcoming pull request + const readme = Buffer.from(readmeBase64.data.content, 'base64').toString('ascii') + const newLineReadme = `\n ${readme}` + const newLineReadmeEncoded = Buffer.from(newLineReadme).toString('base64') + + // create new release-branch + await o.createBranch({ + owner, + repo, + ref: `refs/heads/bump-${bumpTo}`, + sha: baseTagCommit.sha + }) + + // add a new commit to the release-branch + await o.updateReadme({ + owner, + repo, + path: readmeBase64.data.path, + message: `feat(release-management): Bump minor version to ${bumpTo} for release management`, + content: newLineReadmeEncoded, + sha: readmeBase64.data.sha, + branch: `bump-${bumpTo}` + }) + + // create the bump pull request + const pullRequest = await o.createPullRequest({ + owner, + repo, + title: `Bump minor version to ${bumpTo} for release management`, + head: `bump-${bumpTo}`, + base: 'master', + body: `## Description + Bump minor version to ${bumpTo} for release management` + }) + + // response format https://developer.github.com/v3/pulls/#create-a-pull-request + return pullRequest +} diff --git a/octokit.js b/octokit.js new file mode 100644 index 0000000..f939a9e --- /dev/null +++ b/octokit.js @@ -0,0 +1,65 @@ +const octokit = require('@octokit/rest')() + +module.exports = class Octokit { + + constructor (token) { + if (token) { + octokit.authenticate({ + type: 'oauth', + token: token + }) + } + } + + async createPullRequest ({owner, repo, title, head, base, body}) { + return await octokit.pullRequests.create({ + owner: owner, + repo: repo, + title: title, + head: head, + base: base, + body: body, + maintainer_can_modify: true + }) + } + + async getTagsByPage ({repo, owner, page, perPage}) { + return await octokit.repos.getTags({ + owner: owner, + repo: repo, + per_page: perPage, + page: page + }) + } + + async getReadme ({owner, repo}) { + return await octokit.repos.getReadme({ + owner: owner, + repo: repo + }) + } + + async updateReadme ({owner, repo, path, message, content, sha, branch}) { + return await octokit.repos.updateFile({ + owner, + repo, + path, + message, + content, + sha, + branch + }) + } + + // ref: name of the new branch + // e.g. '/refs/heads/my-new-branch' + // sha: sha of the base commit + async createBranch ({owner, repo, ref, sha}) { + return await octokit.gitdata.createReference({ + owner, + repo, + ref, + sha + }) + } +} diff --git a/package.json b/package.json new file mode 100644 index 0000000..e7fb310 --- /dev/null +++ b/package.json @@ -0,0 +1,34 @@ +{ + "name": "@daraff/create-bump-pr", + "version": "0.0.0-development", + "description": "", + "main": "index.js", + "bin": "./cli.js", + "author": "Ralph Meier", + "license": "MIT", + "dependencies": { + "@octokit/rest": "^15.9.4", + "lodash": "^4.17.4", + "semver": "5.5.1", + "yargs": "^12.0.2" + }, + "scripts": { + "semantic-release": "semantic-release", + "travis-deploy-once": "travis-deploy-once" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/DaRaFF/create-bump-pr.git" + }, + "devDependencies": { + "semantic-release": "^15.10.6", + "travis-deploy-once": "^5.0.9" + }, + "publishConfig": { + "access": "public" + }, + "bugs": { + "url": "https://github.com/DaRaFF/create-bump-pr/issues" + }, + "homepage": "https://github.com/DaRaFF/create-bump-pr#readme" +}