prb0t's Introduction

🤖 PRB0t

The Pull Request Bot for Anonymous contributions on GitHub!

With PRB0t you can make pull request on GitHub by using a JSON description of the changes.

Install

npm install -S @prb0t/pr

Usage

  const pr = new PR(body.user, body.repo, body.branch, body.token);

  pr.configure(
      [
        {"path": "<file-path>", "content": "<file-content>"}
      ],
      "<commit-message>",
      "<title>",
      "<description>",
      body.author || {
          name: 'PRB0t',
          email: '[email protected]',
      }
  );

  const { data } = await pr.send(); // data holds the response of the PR creation.

Or host your own version using now.sh:

now PRB0t/PRB0t

You'll be asked for a Github token.

Request Sample:

{
  "user": "<github-user>",
  "repo": "<github-repo>",
  "title": "<pull-request-title>",
  "description": "<pull-request-description>",
  "commit": "<commit-description>",
  "files": [
  	{"path": "<file-path>", "content": "<file-content>"}
  ]
}

What can you do with it?

If you have a static website hosted in github... you could add a button Edit this page.
You can contribute anonymously to the Internet 🕸
You can upload files...
You can use your github for storage...
... etc... ecc..

Try it!

curl -X POST \
  https://xrbhog4g8g.execute-api.eu-west-2.amazonaws.com/prod/prb0t \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -d '{
  "user": "PRB0t",
  "repo": "PRB0t",
  "description": "🤖",
  "title": "Dare to try",
  "commit": "a try",
  "files": [
  	{"path": "README.md", "content": "Failure is when you stop trying to do something."}
  ]
}'