{"id":13406787,"url":"https://github.com/googleapis/repo-automation-bots","last_synced_at":"2026-04-02T19:05:21.888Z","repository":{"id":37484383,"uuid":"194740874","full_name":"googleapis/repo-automation-bots","owner":"googleapis","description":"A collection of bots, based on probot, for performing common maintenance tasks across the open-source repos managed by Google on GitHub.","archived":false,"fork":false,"pushed_at":"2025-05-05T14:35:54.000Z","size":46501,"stargazers_count":673,"open_issues_count":91,"forks_count":145,"subscribers_count":72,"default_branch":"main","last_synced_at":"2025-05-05T15:53:46.643Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/googleapis.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-07-01T20:47:53.000Z","updated_at":"2025-05-05T14:35:57.000Z","dependencies_parsed_at":"2022-07-14T05:30:31.604Z","dependency_job_id":"79f399b3-f525-45cc-8b9a-f78690778307","html_url":"https://github.com/googleapis/repo-automation-bots","commit_stats":{"total_commits":3847,"total_committers":76,"mean_commits":50.61842105263158,"dds":0.8068624902521445,"last_synced_commit":"3bed974117e823cb2a726d6e06602861dd80a5cd"},"previous_names":[],"tags_count":253,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/googleapis%2Frepo-automation-bots","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/googleapis%2Frepo-automation-bots/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/googleapis%2Frepo-automation-bots/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/googleapis%2Frepo-automation-bots/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/googleapis","download_url":"https://codeload.github.com/googleapis/repo-automation-bots/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254041567,"owners_count":22004744,"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":[],"created_at":"2024-07-30T19:02:39.281Z","updated_at":"2026-04-02T19:05:21.877Z","avatar_url":"https://github.com/googleapis.png","language":"TypeScript","funding_links":[],"categories":["TypeScript","others"],"sub_categories":[],"readme":"# Repo Automation Bots\n\nA collection of bots, based on [probot](https://github.com/probot/probot), for\nperforming common maintenance tasks across the open-source repos managed\nby Google on GitHub.\n\n## Implemented Bots\n\n| Name | Description |\n| ---- | ----------- |\n| [auto-approve] | Automatically approves and merges PRs matching user-specified configs |\n| [auto-label] | Automatically labels issues and PRs with product, language, or directory based labels |\n| [blunderbuss] | Assigns issues and PRs randomly to a specific list of users |\n| [cherry-pick-bot] | Cherry-pick merged PRs between branches |\n| [conventional-commit-lint] | PR checker that ensures that the commit messages follow conventionalcommits.org style |\n| [do-not-merge] | PR checker that ensures the `do not merge` label is not present |\n| [failurechecker] | Check for automation tasks, e.g., releases, that are in a failed state |\n| [flakybot] | Listen on PubSub queue for broken builds, and open corresponding issues |\n| [generated-files-bot] | PR checker to notify if you are modifying generated files |\n| [label-sync] | Synchronize labels across organizations |\n| [license-header-lint] | PR checker that ensures that source files contain valid license headers |\n| [merge-on-green] | Merge a pull-request when all required checks have passed |\n| [policy] | Check repo configuration against known rules |\n| [release-please] | Proposes releases based on semantic version commits |\n| [release-trigger] | Trigger releases jobs |\n| [repo-metadata-lint] | Lint .repo-metadata.json files |\n| [snippet-bot] | Check for mismatched region tags in PRs |\n| [sync-repo-settings] | Synchronize repository settings from a centralized config |\n| [trusted-contribution] | Allows Kokoro CI to trigger for trusted contributors |\n\nGooglers: please cont\n\n## Development environment\n\nYou need to install node.js version 12 or higher.\n\nTo manage multiple Node.js versions, you can use\n[nvm](https://github.com/nvm-sh/nvm).\n\n## Running the app locally\n\n### Create a Proxy to Relay Webhooks\n\nIn order to forward to your local machine, you can use smee.io. Visit\nhttps://smee.io/new and create a proxy for relaying webhooks to your\nlocal web-service. After creating the proxy, you'll get the URL of the\nnew proxy.\n\nIn the root directory of `repo-automation-bots`, run:\n\n```\nnpm run proxy -- -u \u003cURL-OF-PROXY\u003e\n```\n\n### Creating the Development Application\n\nIf it's your first time running your application, you should create a new\nGitHub application using the probot server:\n\n1. `cd packages/your-bot`.\n1. `npm start`.\n1. visit:  http://localhost:3000 and install.\n\n### Granting the Development Application permissions and events\n\n1. By default there will be no permissions. Visit\n   https://github.com/settings/installations, click configure, then 'app settings'.\n1. Navigate to Permissions and Events. You likely need 'Repository \u003e Pull Requests'\n   for permissions.\n1. You also will need to subscribe to events (bottom of page). For\n   instance, if your bot responds to PR activity, the 'Events \u003e Pull Request' should\n   be enabled.\n\n\n### Install the bot on a repo\n\n1. Follow the link to install the app and navigate to 'Install App',\n   if installed on the organization you desire (likely yourself for testing),\nclick the gear.\n1. Under permissions ensure that there aren't pending requests to be approved\n1. Under repository access select only select repositories. Select the\n   repository you wish to test against.\n\n\n### Running Your Application\n\nOnce you've created your application, _and installed it on some of your repos_,\nstart probot again, setting the following environment variables. Most can be found\nat github.com/settings/apps/{YOUR_APP}:\n\n* `APP_ID`: the ID, listed near the top, `App ID: 12345`\n* `PRIVATE_KEY_PATH`: path to App's private key, you can request a new one be\n   created and downloaded at the bottom of the page.\n   * Alternatively, set the GitHub client ID and secret:\n     * `GITHUB_CLIENT_ID`: client ID from the top of the page.\n     * `GITHUB_CLIENT_SECRET`: client secret from the top of the page.\n* `WEBHOOK_SECRET`: secret key set in GitHub developer settings. Edit this to a known value in the settings page.\n\nEnvironment variables set, run:\n\n1. `cd packages/your-bot`.\n1. `npm start`.\n\n### Running bots on a Cron\n\nTo run a bot on a schedule include a file in your bot's folder named `cron` whose\ncontent is valid [unix -cron format](http://man7.org/linux/man-pages/man5/crontab.5.html).\nThis will create a Cloud Scheduler Job which makes requests to your endpoint\nat the specified schedule.\n\n### Publishing Utility Modules\n\n1. create a token with Wombat Dressing Room.\n2. run `npm run release`.\n\n## Overall Architecture\n\n![High Level Architecture](./architecture.png)\n\n[auto-approve]: https://github.com/googleapis/repo-automation-bots/tree/main/packages/auto-approve\n[auto-label]: https://github.com/googleapis/repo-automation-bots/tree/main/packages/auto-label\n[blunderbuss]: https://github.com/googleapis/repo-automation-bots/tree/main/packages/blunderbuss\n[cherry-pick-bot]: https://github.com/googleapis/repo-automation-bots/tree/main/packages/cherry-pick-bot\n[conventional-commit-lint]: https://github.com/googleapis/repo-automation-bots/tree/main/packages/conventional-commit-lint\n[do-not-merge]: https://github.com/googleapis/repo-automation-bots/tree/main/packages/do-not-merge\n[generated-files-bot]: https://github.com/googleapis/repo-automation-bots/tree/main/packages/generated-files-bot\n[license-header-lint]:  https://github.com/googleapis/repo-automation-bots/tree/main/packages/header-checker-lint\n[policy]:  https://github.com/googleapis/repo-automation-bots/tree/main/packages/policy\n[release-please]:  https://github.com/googleapis/repo-automation-bots/tree/main/packages/release-please\n[release-trigger]:  https://github.com/googleapis/repo-automation-bots/tree/main/packages/release-trigger\n[trusted-contribution]: https://github.com/googleapis/repo-automation-bots/tree/main/packages/trusted-contribution\n[failurechecker]: https://github.com/googleapis/repo-automation-bots/tree/main/packages/failurechecker\n[label-sync]: https://github.com/googleapis/repo-automation-bots/tree/main/packages/label-sync\n[flakybot]: https://github.com/googleapis/repo-automation-bots/tree/main/packages/flakybot\n[merge-on-green]: https://github.com/googleapis/repo-automation-bots/tree/main/packages/merge-on-green\n[snippet-bot]: https://github.com/googleapis/repo-automation-bots/tree/main/packages/snippet-bot\n[sync-repo-settings]: https://github.com/googleapis/repo-automation-bots/tree/main/packages/sync-repo-settings\n[Wombat Dressing Room]: https://opensource.googleblog.com/2020/01/wombat-dressing-room-npm-publication_10.html\n[repo-metadata-lint]: https://github.com/googleapis/repo-automation-bots/tree/main/packages/repo-metadata-lint\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgoogleapis%2Frepo-automation-bots","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgoogleapis%2Frepo-automation-bots","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgoogleapis%2Frepo-automation-bots/lists"}