Merge pull request #30 from uiur/master

Release 2022-11-13 11:07:50

Author: uiur

.github/workflows/create-pr.js.yml

@@ -2,25 +2,25 @@ name: Create a pull request for QA
 
 on:
   push:
-    branches: [ master ]
+    branches: [master]
 
 jobs:
   build:
     runs-on: ubuntu-latest
-    
+
     steps:
-    - uses: actions/checkout@v2
-    - name: Use Node.js 
-      uses: actions/setup-node@v2
-      with:
-        node-version: 16.x
-        cache: 'npm'
-        
-    - run: npm ci
-    - run: npm run build --if-present
-    - name: Create a release pull request
-      env:
-        GITHUB_PR_RELEASE_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        
-      run: |
-        ./cli/index.js uiur/github-pr-release
+      - uses: actions/checkout@v2
+      - name: Use Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: 16.x
+          cache: "npm"
+
+      - run: npm ci
+      - run: npm run build --if-present
+      - name: Create a release pull request
+        env:
+          GITHUB_PR_RELEASE_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+        run: |
+          ./cli/index.js uiur/github-pr-release

.github/workflows/node.js.yml

@@ -5,13 +5,12 @@ name: Node.js CI
 
 on:
   push:
-    branches: [ master ]
+    branches: [master]
   pull_request:
-    branches: [ master ]
+    branches: [master]
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
 
     strategy:
@@ -20,12 +19,12 @@ jobs:
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v2
-      with:
-        node-version: ${{ matrix.node-version }}
-        cache: 'npm'
-    - run: npm ci
-    - run: npm run build --if-present
-    - run: npm test
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: "npm"
+      - run: npm ci
+      - run: npm run build --if-present
+      - run: npm test

.github/workflows/release.js.yml

@@ -1,7 +1,7 @@
 name: npm publish
 on:
   pull_request:
-    types: [ closed ]
+    types: [closed]
 
   # Enable running this workflow manually from the Actions tab
   workflow_dispatch:
@@ -15,8 +15,8 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
-          node-version: '16.x'
-          cache: 'npm'
+          node-version: "16.x"
+          cache: "npm"
       - run: npm ci
       - run: npm run build --if-present
       - run: npm test

.gitignore

@@ -33,3 +33,4 @@ node_modules
 npm-debug.log
 
 test.js
+dist

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged

README.md

@@ -1,37 +1,48 @@
 # github-pr-release
+
 [![](https://img.shields.io/npm/v/github-pr-release.svg)](https://www.npmjs.com/package/github-pr-release)
 
-Create a release pull request by using Github API. Inspired by [git-pr-release]( https://github.com/motemen/git-pr-release).
+Create a release pull request using GitHub API. Inspired by [git-pr-release](https://github.com/motemen/git-pr-release).
 
-* No dependency on git. You can easily deploy it to Heroku etc.
-* Fast because it uses only Github API.
+- No dependency on git. You can easily deploy it to Heroku / AWS Lambda / Google Cloud Functions etc.
+- Fast because it uses only Github API.
+- Written in JavaScript.
 
 [![Gyazo](http://i.gyazo.com/7484a59ade4e96ce9a015f1aa817cab8.png)](http://gyazo.com/7484a59ade4e96ce9a015f1aa817cab8)
 
-
 ## Usage
+
+<<<<<<< HEAD
+
 ### release(config)
+
+=======
+
+### API: release(config)
+
+> > > > > > > origin/master
+
 Create a release pull request and return Promise.
 
 You must pass a config as an argument.
 
-``` javascript
-const release = require('github-pr-release')
+```javascript
+const release = require("github-pr-release");
 
 const config = {
-  token: 'your github token',
-  owner: 'uiur',
-  repo:  'awesome-web-app',
-  head:  'master',                       // optional
-  base:  'production',                   // optional
-  template: '/path/to/template.mustache' // optional
-}
+  token: "your github token",
+  owner: "uiur",
+  repo: "awesome-web-app",
+  head: "master", // optional
+  base: "production", // optional
+  template: "/path/to/template.mustache", // optional
+};
 
 release(config).then(function (pullRequest) {
   // success
   // `pullRequest` is an object that github api returns.
   // See: https://developer.github.com/v3/pulls/#get-a-single-pull-request
-})
+});
 ```
 
 Also, the following environment variables can be used for the config:
@@ -43,18 +54,45 @@ Also, the following environment variables can be used for the config:
 - `GITHUB_PR_RELEASE_BASE`
 - `GITHUB_PR_RELEASE_ENDPOINT`
 
+### CLI
+
+You can create a release pull request by the following command:
+
+```sh
+❯ npx github-pr-release owner/repo --head master --base production
+# `GITHUB_PR_RELEASE_TOKEN` is required
+```
+
+`--help`:
+
+```
+❯ npx github-pr-release --help
+Usage: github-pr-release [repo]
+
+Options:
+  --help     Show help                                                 [boolean]
+  --version  Show version number                                       [boolean]
+  --head                                                     [default: "master"]
+  --base                                                 [default: "production"]
+
+Examples:
+  github-pr-release uiur/github-pr-release --head master --base production
+```
 
 ## Install
+
 ```
 npm install github-pr-release
 ```
 
 ## Tips
+
 ### Pull request titles
 
 If one of pull requests of which consist a release pull request has a title like "Bump to v1.0", the title of the release pull request becomes "Release v1.0". Otherwise, it uses timestamps like "Release 2000-01-01 00:00:00" in local timezone.
 
 ### Specify a message format
+
 You can specify a template to change the message format. Pass a template path to `config.template`.
 
 ```javascript
@@ -76,6 +114,7 @@ Release {{version}}
 ```
 
 ### GitHub Enterprise
+
 If you use this plugin in GitHub Enterprise, you can specify endpoint domain for GitHub Enterprise.
 
 ```javascript
@@ -89,10 +128,43 @@ release({
 
 ## Example
 
+### GitHub Actions
+
+Creating release pull requests can be automated using GitHub Actions.
+
+Create `.github/workflows/create-pr-release.yml` with the following content:
+
+```yml
+name: Create release pull requests
+
+on:
+  push:
+    branches: [master]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 16.x
+          cache: "yarn"
+
+      - run: yarn install
+      - name: Create release pull requests
+        run: |
+          npx github-pr-release $GITHUB_REPOSITORY --head master --base production
+        env:
+          GITHUB_PR_RELEASE_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+
 ### hubot
+
 ![](http://i.gyazo.com/018755d09bbc857aeafdf48372912d79.png)
 
-``` coffee
+```coffee
 release = require('github-pr-release')
 module.exports = (robot) ->
   robot.respond /release/i, (msg) ->
@@ -104,5 +176,13 @@ module.exports = (robot) ->
     )
 ```
 
+## Development
+
+The release flow of github-pr-release is managed with github-pr-release itself.
+
+It creates a release pull request when merging a topic branch or pushing to the main branch.
+The update can be published by merging a release pull request.
+
 ## License
+
 MIT

cli/index.js

@@ -1,33 +1,32 @@
 #!/usr/bin/env node
 
-const yargs = require('yargs/yargs')
-const { hideBin } = require('yargs/helpers')
+const yargs = require("yargs/yargs");
+const { hideBin } = require("yargs/helpers");
 const argv = yargs(hideBin(process.argv))
-  .usage('Usage: $0 [repo]')
-  .example('$0 uiur/github-pr-release --head master --base production', '')
+  .usage("Usage: $0 [repo]")
+  .example("$0 uiur/github-pr-release --head master --base production", "")
   .demandCommand(1)
-  .default('head', 'master')
-  .default('base', 'production')
-  .argv
+  .default("head", "master")
+  .default("base", "production").argv;
 
-const createReleasePR = require('../')
+const createReleasePR = require("../");
 
-async function main () {
-  const repoInput = argv._[0]
-  const [owner, repo] = repoInput.split('/')
+async function main() {
+  const repoInput = argv._[0];
+  const [owner, repo] = repoInput.split("/");
   const config = {
     owner,
     repo,
     head: argv.head,
-    base: argv.base
-  }
+    base: argv.base,
+  };
 
-  const pullRequest = await createReleasePR(config)
+  const pullRequest = await createReleasePR(config);
 
-  console.log(pullRequest.html_url)
+  console.log(pullRequest.html_url);
 }
 
-main().catch(err => {
-  console.error(err)
-  process.exit(1)
-})
+main().catch((err) => {
+  console.error(err);
+  process.exit(1);
+});