{"id":13618003,"url":"https://github.com/infection/tests-checker","last_synced_at":"2025-09-29T08:31:42.737Z","repository":{"id":39565399,"uuid":"148936727","full_name":"infection/tests-checker","owner":"infection","description":"[BOT] Requires writing the tests in Pull Requests.","archived":true,"fork":false,"pushed_at":"2023-05-03T09:19:54.000Z","size":1387,"stargazers_count":38,"open_issues_count":20,"forks_count":7,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-10-29T18:39:41.574Z","etag":null,"topics":["github-app","infection","probot","probot-app","tests"],"latest_commit_sha":null,"homepage":"https://probot.github.io/apps/tests-checker/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/infection.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null},"funding":{"github":["infection"],"open_collective":"infection"}},"created_at":"2018-09-15T20:16:31.000Z","updated_at":"2023-05-03T09:20:40.000Z","dependencies_parsed_at":"2023-10-12T07:30:11.279Z","dependency_job_id":null,"html_url":"https://github.com/infection/tests-checker","commit_stats":{"total_commits":29,"total_committers":5,"mean_commits":5.8,"dds":0.3793103448275862,"last_synced_commit":"7329efab252d7915c2341db927f298c39381dc14"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infection%2Ftests-checker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infection%2Ftests-checker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infection%2Ftests-checker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/infection%2Ftests-checker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/infection","download_url":"https://codeload.github.com/infection/tests-checker/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234533332,"owners_count":18848176,"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","infection","probot","probot-app","tests"],"created_at":"2024-08-01T20:01:52.477Z","updated_at":"2025-09-29T08:31:42.335Z","avatar_url":"https://github.com/infection.png","language":"TypeScript","funding_links":["https://github.com/sponsors/infection","https://opencollective.com/infection"],"categories":["TypeScript"],"sub_categories":[],"readme":"\u003e **Warning**\n\u003e \n\u003e This GitHub App has been deprecated in favor of GitHub Action with the same functionality: https://github.com/infection/tests-checker-action\n\n[![Build Status](https://travis-ci.org/infection/tests-checker.svg?branch=master)](https://travis-ci.org/infection/tests-checker)\n\n# Tests Checker\n\nTo install this bot to your Open Sourced project:\n\n* open https://github.com/apps/tests-checker\n* click \"Install\"\n* choose the repository you want to install `tests-checker` to\n\n\u003cimg width=\"990\" alt=\"tests-checker\" src=\"https://user-images.githubusercontent.com/3725595/45590526-b7f3fa00-b942-11e8-972d-143c0b367017.png\"\u003e\n\n\n## Settings\n\nYou can configure bot by adding `.github/tests_checker.yml` file to the repository and override any of the settings listed below.\n\nDefault values are:\n\n```yaml\ncomment: 'Could you please add tests to make sure this change works as expected?',\nfileExtensions: ['.php', '.ts', '.js', '.c', '.cs', '.cpp', '.rb', '.java']\ntestDir: 'tests'\ntestPattern: ''\n```\n\nwhere\n\n* `comment` - a text that bot will post when it won't find tests in the PR\n* `fileExtensions` - extensions of the files that should be treated as a `source code`. Bot will do nothing if you just updating `README.md` because usually no tests are required to cover such change.\n* `testDir` - folder, where tests are located. Make sure to set it correctly, otherwise bot will not be able to understand whether the test file was added or not.\n* `testPattern` - a shell glob pattern that should match test files. For example, you can set it to `testPattern: *_test.go` and Bot will be able to understand, that added test has this pattern instead of located in `testDir`. `testDir` and `testPattern` are alternatives, however can be used together.\n\nBoth `testDir` and `testPattern` may be specified in a custom configuration, both settings will be used to locate test files.\nIf you want to change any of the settings, just add `.github/tests_checker.yml`:\n\n```yaml\ntestDir: app-tests\n```\n\nIf you don't want to change anything, you can skip creating this file.\n\n## Setup\n\nThis is needed if you want to deploy this bot to your server or want to contribute to it.\nPlease note, that `tests-checker` is ready to use.\nYou just need to install Github Application as mentioned in above.\n\n```sh\n# Install dependencies\nnpm install\n\n# Run typescript\nnpm run build\n\n# Run the bot for production or\nnpm start\n\n# for development\nnpm run dev\n```\n\n## Deploy\n\nInstall `now`:\n\n`npm install -g now`\n\nDeploy:\n\n```bash\nnow -e APP_ID=17064 \\\n    -e WEBHOOK_SECRET=XXX \\\n    -e PRIVATE_KEY_BASE64=\"$(cat ./key.pem | base64)\"\n```\n\nSee `WEBHOOK_SECRET` on GitHub app: https://github.com/settings/apps/tests-checker.\n\nSet a permanent alias for the new deployed application URL:\n\n```bash\nnow alias set https://tests-checker-XYZ.now.sh https://tests-checker.now.sh\n```\n\n### Debugging `now.sh`\n\n* `now ls tests-checker`\n* `now inspect tests-checker.now.sh`\n* `now rm tests-checker-qkkyxnelyo.now.sh` to free some instances available for OSS plan\n\n## Contributing\n\nIf you have suggestions for how `tests-checker` could be improved, or want to report a bug, open an issue!\nWe'd love all and any contributions.\n\nFor more, check out the [Contributing Guide](CONTRIBUTING.md).\n\n\u003e A GitHub App built with [Probot](https://github.com/probot/probot) that require writing tests in Pull Requests.\n\n# Developing\n\n1. Read https://probot.github.io/docs/development/#manually-configuring-a-github-app and configure `smee`\n2. add generated `smee` URL to `.env` - `WEBHOOK_PROXY_URL` variable, and to github app: https://github.com/settings/apps/tests-checker-dev\n3. Open terminal 1 and run `smee -u https://smee.io/xxx`\n4. open terminal 2 and run `npm start`\n5. now bot is ready to work from the local machine! \n\n## License\n\n[ISC](LICENSE) © 2018 Maks Rafalko \u003cmaks.rafalko@gmail.com\u003e (https://github.com/infection/tests-checker)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finfection%2Ftests-checker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finfection%2Ftests-checker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finfection%2Ftests-checker/lists"}