pgp-commit

1.0.0 • Public • Published

PGP Commit

Sign a commit with openpgp and nodegit

Install

npm install pgp-commit

Example

See more examples in examples folder

const git = require('nodegit')
const pgpCommit = require('pgp-commit')
 
run()
 
async function run() {
  // clone a repo
  const repo = await git.Clone('https://github.com/owner/repo', '/temp/repo')
  const commitMessage = 'add data to something'
  const author = git.Signature.now('test', 'test@test.com')
  const committer = git.Signature.now('test', 'test@test.com')
 
  // make a change
  fs.writeFileSync('/temp/repo/nothing', 'nothing')
 
  // stage the change
  const index = await repo.refreshIndex()
  await index.addAll()
  await index.write()
 
  // make a signed commit
  const commitId = await pgpCommit({
    repo,
    commitMessage,
    author,
    committer,
    passphrase,
    privateKey
  })
}

Add your public GPG key to github

see https://help.github.com/articles/adding-a-new-gpg-key-to-your-github-account/

Get your private key from cmd line

$ gpg --export-secret-key -a "username"

Readme

Keywords

none

Package Sidebar

Install

npm i pgp-commit

Weekly Downloads

6

Version

1.0.0

License

MIT

Unpacked Size

6.88 kB

Total Files

6

Last publish

Collaborators

  • dabutvin