github-empty-commit

Create a empty commit via GitHub API

Usage no npm install needed!

<script type="module">
  import githubEmptyCommit from 'https://cdn.skypack.dev/github-empty-commit';
</script>

README

github-empty-commit

Create a empty commit via GitHub API

Installation

yarn add github-empty-commit

Usage

import { githubEmptyCommit } from 'github-empty-commit'
const example = async () => {
  const success = await githubEmptyCommit({
    // The username/organization of the repository owner
    owner: 'siberianmh'
    // The name of the repository
    repo: 'need-some-ice',
  })
}

API

This module exports a single function that returns an boolean

githubEmptyCommit([options])

  • options Object
    • owner Required - The username of the repository owner
    • repo Required - The name of the repository
    • commitMessage - The message of created commit
    • ref - The branch name in style heads/some-nice-branch

License

MIT