Wondering what’s next for npm?Check out our public roadmap! »

make-empty-github-commit

1.2.1 • Public • Published

make-empty-github-commit

Makes a new empty commit on GitHub using API

NPM

Build status semantic-release js-standard-style

Install

Requires Node version 6 or above.

npm install --save make-empty-github-commit

Use

CLI

From command line

$(npm bin)/empty-commit --repo <username/repo> --message "Empty commit message"

You can pass repo in different format, it will be parsed using parse-github-repo-url.

Optional arguments:

--branch <master>

Aliases: --repo -r, --message -m, --branch -b

For authentication, set environment variable with your GitHub personal token under name TOKEN, GH_TOKEN or GITHUB_TOKEN

API

const emptyGitHubCommit = require('make-empty-github-commit')
emptyGitHubCommit({
  owner: 'username',
  repo: 'repo name',
  token: process.env.TOKEN,
  message: 'my message',
  branch: 'develop' // "master" is default
}).then(console.log, e => {
  console.error(e)
  process.exit(1)
})

Resolves with an object with at least sha property of the new commit.

Uses http://mikedeboer.github.io/node-github to make API calls.

Testing

To test this project I created dummy repo test-make-empty-github-commit. See its commit history to see empty commit messages created from this repository using tests in test folder.

Debugging

Run the tool with environment variable DEBUG=make-empty-github-commit

Related

This code started as a fork of commit-to-github, but was simplified for creating just empty commits.

Small print

Author: Gleb Bahmutov <gleb.bahmutov@gmail.com> © 2017

License: MIT - do anything with the code, but don't blame me if it does not work.

Support: if you find any problems with this module, email / tweet / open issue on Github

MIT License

Copyright (c) 2017 Gleb Bahmutov <gleb.bahmutov@gmail.com>

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.

Install

npm i make-empty-github-commit

DownloadsWeekly Downloads

568

Version

1.2.1

License

MIT

Unpacked Size

10.9 kB

Total Files

4

Last publish

Collaborators

  • avatar