{"id":13561388,"url":"https://github.com/godaddy/pullie","last_synced_at":"2025-04-12T19:53:25.984Z","repository":{"id":33050452,"uuid":"150498706","full_name":"godaddy/pullie","owner":"godaddy","description":"A GitHub bot that makes your PRs better","archived":false,"fork":false,"pushed_at":"2024-07-23T20:48:14.000Z","size":4301,"stargazers_count":20,"open_issues_count":12,"forks_count":4,"subscribers_count":10,"default_branch":"main","last_synced_at":"2025-04-12T19:53:21.512Z","etag":null,"topics":["bot","github","github-app","github-bot","githubapp","hacktoberfest","pull-request","pull-requests","pullrequest"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/godaddy.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-09-26T22:46:56.000Z","updated_at":"2024-07-11T07:42:54.000Z","dependencies_parsed_at":"2023-12-17T17:28:54.301Z","dependency_job_id":"14d7373b-a141-4308-a968-82334fbfe019","html_url":"https://github.com/godaddy/pullie","commit_stats":{"total_commits":175,"total_committers":10,"mean_commits":17.5,"dds":"0.41714285714285715","last_synced_commit":"9e109c13f0ee4e93d5739529af86641de7bdff10"},"previous_names":[],"tags_count":44,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/godaddy%2Fpullie","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/godaddy%2Fpullie/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/godaddy%2Fpullie/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/godaddy%2Fpullie/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/godaddy","download_url":"https://codeload.github.com/godaddy/pullie/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248625509,"owners_count":21135513,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bot","github","github-app","github-bot","githubapp","hacktoberfest","pull-request","pull-requests","pullrequest"],"created_at":"2024-08-01T13:00:55.651Z","updated_at":"2025-04-12T19:53:25.961Z","avatar_url":"https://github.com/godaddy.png","language":"JavaScript","readme":"![Node.js CI](https://github.com/godaddy/pullie/workflows/Node.js%20CI/badge.svg) [![Coverage Status](https://coveralls.io/repos/github/godaddy/pullie/badge.svg?branch=master)](https://coveralls.io/github/godaddy/pullie?branch=master)\n\n[![NPM](https://nodei.co/npm/pullie.png?downloads=true\u0026stars=true)](https://nodei.co/npm/pullie/)\n\n# pullie\n\nPullie is a GitHub bot that makes your PRs better. It runs as a GitHub App and receives webhook calls whenever a pull\nrequest is made against a repo on which the app is installed. Plugins provide handy functionality like linking to Jira\ntickets, requesting reviews, and commenting about a missing required file change.\n\n## System requirements\n\nPullie runs on public GitHub or on GitHub Enterprise 2.14 or later. It requires Node.js 14 or later.\n\n## How to run/deploy\n\nThe easiest way to run Pullie is to clone this repo and run `npm start`. You can do so in a Docker container for easy\ndeployment.\n\n## Configuration\n\nYou must specify configuration values via environment variables. You may do so using a `.env` file. See\n[`.env.example`](./.env.example) for a sample configuration with full documentation.\n\n### Setting up your GitHub App\n\nPullie runs as a GitHub App, so if you are installing it on your own GitHub Enterprise instance, you must register a\nGitHub App there first. Here's how:\n\n1. Browse to your GHE server homepage\n2. Go to your user icon in the top right and select **Settings** from the menu\n3. Select **Developer Settings** on the left side\n4. Select **GitHub Apps** on the left side\n5. Press the **New GitHub App** button on the top right\n6. Fill out the form as follows:\n\n- **GitHub App name:** Pullie\n- **Description (optional):** Pullie is a GitHub bot that makes your PRs better. It runs as a GitHub App and receives\n  webhook calls whenever a pull request is made against a repo on which the app is installed. Plugins provide handy\n  functionality like linking to Jira tickets, requesting reviews, and commenting about a missing required file change.\n- **Homepage URL:** The base URL of your Pullie deployment (e.g. https://pullie.example.com)\n- **User authorization callback URL:** Same URL as above\n- **Setup URL (optional):** Not needed -- leave this blank\n- **Webhook URL:** Your deployment's base URL (e.g. https://pullie.example.com/) (unless `WEBHOOK_PATH` is adjusted in\n  config)\n- **Webhook secret (optional):** Choose a random string as your webhook secret (e.g. a random UUID perhaps)\n\n- **Permissions:** Leave all as **No access** _except_ the following:\n  - **Repository administration:** Read-only\n  - **Repository contents:** Read-only\n  - **Repository metadata:** Read-only\n  - **Pull requests:** Read \u0026 write\n  - **Single file:** Read-only for `.pullierc`\n  - **Organization members:** Read-only\n\n- **Subscribe to events:** Leave all unchecked _except_ **Pull request**\n\n- **Where can this GitHub App be installed?** This is up to you. If you choose **Only on this account**, other users in\n  your GHE instance will not see your application.\n\n7. Press the **Create GitHub App** button\n8. Now you have a GitHub App, so we need to collect some information to use in our configuration file:\n  - Scroll to the bottom of the configuration page for your new GitHub App\n  - Copy the **ID** and use as your app's ID in the config file\n  - Copy the **Client ID** and use as your app's client ID in the config file\n  - Copy the **Client secret** and use as your app's client secret in the config file\n  - Click the **Generate private key** button to create your app's private key file. Copy the file it downloads to your\n    Pullie deployment in a secure place (e.g. by using Kubernetes Secrets)\n9. Upload a logo for Pullie. You can use one of the PNG files in the `static` folder of the Pullie npm package if you'd\n  like.\n\n### Install your GitHub App on an org/user\n\nNow, you can install your GitHub App on an org or user. Select **Install App** on the left side of the App's config \npage and then press the green **Install** button on any org(s) and/or user(s) you'd like Pullie to run on. Pullie will\nnot do anything unless a repo has a `.pullierc` file, so it is safe to install across an org.\n\n## User documentation\n\nUser docs are available at the docs URL of your Pullie deployment (e.g https://pullie.example.com/docs). Just browse\nthere and you'll see full documentation on installing the App and configuring a repo to work with it.\n","funding_links":[],"categories":["Code Reviews"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgodaddy%2Fpullie","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgodaddy%2Fpullie","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgodaddy%2Fpullie/lists"}