{"id":15140248,"url":"https://github.com/behaviorbot/update-docs","last_synced_at":"2025-10-23T15:31:50.099Z","repository":{"id":85940721,"uuid":"97040269","full_name":"behaviorbot/update-docs","owner":"behaviorbot","description":"Prompts users to include documentation in pull requests","archived":false,"fork":false,"pushed_at":"2018-10-17T22:02:17.000Z","size":101,"stargazers_count":32,"open_issues_count":2,"forks_count":9,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-09-27T08:02:24.943Z","etag":null,"topics":["github-app","probot","probot-app"],"latest_commit_sha":null,"homepage":"https://github.com/apps/update-docs","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/behaviorbot.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":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-07-12T18:29:50.000Z","updated_at":"2024-02-21T00:09:42.000Z","dependencies_parsed_at":"2023-03-04T11:15:22.611Z","dependency_job_id":null,"html_url":"https://github.com/behaviorbot/update-docs","commit_stats":{"total_commits":34,"total_committers":6,"mean_commits":5.666666666666667,"dds":0.3529411764705882,"last_synced_commit":"828f8cfa99a7f17a70287fe76a1941c5e23592bd"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/behaviorbot%2Fupdate-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/behaviorbot%2Fupdate-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/behaviorbot%2Fupdate-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/behaviorbot%2Fupdate-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/behaviorbot","download_url":"https://codeload.github.com/behaviorbot/update-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219868021,"owners_count":16555801,"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":["github-app","probot","probot-app"],"created_at":"2024-09-26T08:01:45.960Z","updated_at":"2025-10-23T15:31:49.738Z","avatar_url":"https://github.com/behaviorbot.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# update-docs\n\n\u003e a GitHub App built with [probot](https://github.com/probot/probot) that comments on newly opened Pull Requests that do not update either the README or a file in the `/docs` folder. \n\n\u003cimg width=\"810\" alt=\"screen shot 2017-07-12 at 2 59 22 pm\" src=\"https://user-images.githubusercontent.com/13410355/28179044-97207bee-67b5-11e7-80d0-0c8ede4a325f.png\"\u003e\n\n## Usage\n\n1. Install the bot on the intended repositories. The plugin requires the following **Permissions and Events**:\n- Pull requests: **Read \u0026 Write**\n  - [x] check the box for **Pull Request** events\n2. Add a `.github/config.yml` file that contains the contents you would like to reply within an `updateDocsComment`\n3. Optionally, you can also add a `whiteList` that includes terms, that if found in the title, the bot will not comment on.\n4. Optionally, you can also add `targetFiles` that includes the files or paths to consider documentation.\n```yml\n# Configuration for update-docs - https://github.com/behaviorbot/update-docs\n\n# Comment to be posted to on PRs that don't update documentation\nupdateDocsComment: \u003e\n  Thanks for opening this pull request! The maintainers of this repository would appreciate it if you would update some of our documentation based on your changes.\n\nupdateDocsWhiteList:\n  - bug\n  - chore\n\nupdateDocsTargetFiles:\n  - README\n  - docs/\n```\n\n## Setup\n\n```\n# Install dependencies\nnpm install\n\n# Run the bot\nnpm start\n```\n\nSee [the probot deployment docs](https://github.com/probot/probot/blob/master/docs/deployment.md) if you would like to run your own instance of this plugin.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbehaviorbot%2Fupdate-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbehaviorbot%2Fupdate-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbehaviorbot%2Fupdate-docs/lists"}