{"id":16477980,"url":"https://github.com/jwcesign/gitautomator","last_synced_at":"2025-05-01T06:31:01.891Z","repository":{"id":231055683,"uuid":"780777145","full_name":"jwcesign/gitautomator","owner":"jwcesign","description":"A smart automated GitHub bot for managing GitHub projects.","archived":false,"fork":false,"pushed_at":"2024-04-02T06:53:11.000Z","size":125,"stargazers_count":6,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-06T10:08:05.317Z","etag":null,"topics":["auto-comment","auto-labeling","auto-merge","automation","github-bot","open-source"],"latest_commit_sha":null,"homepage":"https://github.com/apps/gitautomator","language":"Python","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/jwcesign.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2024-04-02T06:22:35.000Z","updated_at":"2024-06-24T02:21:52.000Z","dependencies_parsed_at":"2024-04-02T07:50:46.823Z","dependency_job_id":null,"html_url":"https://github.com/jwcesign/gitautomator","commit_stats":null,"previous_names":["jwcesign/gitautomator"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwcesign%2Fgitautomator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwcesign%2Fgitautomator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwcesign%2Fgitautomator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwcesign%2Fgitautomator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jwcesign","download_url":"https://codeload.github.com/jwcesign/gitautomator/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251835456,"owners_count":21651661,"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":["auto-comment","auto-labeling","auto-merge","automation","github-bot","open-source"],"created_at":"2024-10-11T12:47:29.833Z","updated_at":"2025-05-01T06:31:01.623Z","avatar_url":"https://github.com/jwcesign.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n    \u003ca href=\"https://github.com/apps/gitautomator\"\u003e\u003cimg height=\"100px\" alt=\"logo\" src=\"./images/logo.png\"\u003e\u003c/a\u003e\n    \u003cp\u003e\n        \u003cem\u003eA smart automated GitHub bot for managing GitHub projects.\u003c/em\u003e\n    \u003c/p\u003e\n    \u003cdiv\u003e\n        \u003ca href=\"#\"\u003e\n            \u003cimg src=\"https://img.shields.io/badge/python-3.11-blue\" /\u003e\n        \u003c/a\u003e\n        \u003ca href=\"https://github.com/jwcesign/gitautomator/blob/main/LICENSE\"\u003e\n            \u003cimg src=\"https://img.shields.io/github/license/jwcesign/gitautomator\" alt=\"License\" /\u003e\n        \u003c/a\u003e\n        \u003ca href=\"https://github.com/jwcesign/gitautomator/stargazers\"\u003e\n            \u003cimg src=\"https://img.shields.io/github/stars/jwcesign/gitautomator?style=plastic\" /\u003e\n        \u003c/a\u003e\n    \u003c/div\u003e\n\u003c/div\u003e\n\n## ❤️ Introduction\n\nGitAutomator responds to various events in your repository, acting as a smart assistant to enhance maintenance efficiency.\n\n## 💾 Installation\n\nVisit the relevant [GitHub APP](https://github.com/apps/gitautomator) page to install GitAutomator. After installation, comment `/cat` on an issue or PR to check its functionality.\n\n## ⛵  Plugins and Functions\n\n| Name | Description |\n| ---- | ----------- |\n| cat | To verify if GitAutomator functions properly with your repository, use the `/cat` command in an issue or PR |\n| ailabel | GitAutomator will utilize ChatGPT to label an issue or PR based on the labels in your repository and the issue/PR content |\n| aireleasenote | GitAutomator checks the release note block\u003csup\u003e[1]\u003c/sup\u003e, assesses its appropriateness, and provides notifications |\n| approve | GitAutomator will approve and merge a PR when the maintainer comments `/approve` |\n| cherrypick | GitAutomator will cherry-pick the commits of the PR to another `\u003ctarget_branch\u003e` when the maintainer comments `/cherry-pick \u003ctarget_branch\u003e` |\n| label | GitAutomator will add `\u003ctarget_label\u003e` to the PR or issue when an account comments `/label \u003ctarget_label\u003e` |\n| prcomment | GitAutomator will post a thank you comment when a new PR is submitted |\n| prlabel | GitAutomator will label a PR based on its title; it will label a title prefixed with `fix` as `bug`, `doc` as `documentation`, and `feat` as `enhancement` |\n| prreact | GitAutomator will react with a heart when a new PR is submitted |\n| prreviewrequest | GitAutomator will automatically request reviews from the maintainers configured in `.github/gitautomator.yaml` |\n\n* **[1]**: The PR body should contain the following block:\n\n  \u003cimg src=\"./images/release-note.png\" width=\"400px\"\u003e\n\n  This could work excellently if you're looking to automatically generate polished release notes. Feel free to use this [template](./.github/pull-request-template.md) for your PR.\n\n## 📃 Configuration\n\nYou can define the specific behavior by configuring the `.github/gitautomator.yaml` file in your repository. The complete configuration is as follows:\n```yaml\nowners:\n- jwcesign # This identifies the maintainer of this repository. GitAutomator will request reviews from them for any new PR.\nplugins:\n- cat # This identifies the plugins to enable. If left blank, all plugins will be enabled.\n```\n\n## 🚀 Self Hosting Guide\n\nUse the official GitHub App to manage your code repository. You can also deploy this App on a self-hosted server. Here are the detailed instructions.\n\n### Create GitHub App\n\nFirst, you need to create a GitHub app. GitHub itself [documents this](https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/registering-a-github-app). Below is the set of permissions needed.\n\nRepository permissions:\n\n* Commit statuses: Read and write\n* Contents: Read and write\n* Merge queues: Read and write\n* Metadata: Read-only\n* Pull requests: Read and write\n* Issues: Read and write\n\nIn Subscribe to events select following events:\n* Commit comment\n* Issue comment\n* Issues\n* Label\n* Merge group\n* Merge queue entry\n* Pull request\n\n### Obtain App ID and Private Key\n\nAfter creating a GitHub App, download the private key as `app.pem` in the current directory and remember the App ID.\n\n### Create a Webhook Channel\n\nVisit [https://smee.io](https://smee.io) to create a new channel, and remember the webhook proxy URL.\n\n### Configure GitHub App Webhook URL\n\nNavigate to the GitHub App settings page, and fill the App's webhook URL field with the Smee webhook proxy URL.\n\n### Launch the Service\n\n1. Clone repository:\n```sh\ngit clone https://github.com/jwcesign/gitautomator.git\n```\n\n2. Export the necessary environment variables:\n```sh\nexport APP_ID=xxx\nexport SMEEIO_URL=xxx\nexport CHATGPT_URL=https://api.openai.com/v1 # you can set another URL\nexport OPENAI_KEY=xxx # your OpenAI secret key\n```\n\n3. Run the container service:\n```\ndocker-compose up -d\n```\n\n4. Enjoy your time!\n\n## 🤝 Contribution\n\nIf you are interested in participating in joint development, welcome to STAR/FORK/PR.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjwcesign%2Fgitautomator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjwcesign%2Fgitautomator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjwcesign%2Fgitautomator/lists"}