{"id":20187512,"url":"https://github.com/wordpress-mobile/test-case-reminder-bot","last_synced_at":"2026-05-31T01:31:19.784Z","repository":{"id":39676839,"uuid":"219716222","full_name":"wordpress-mobile/test-case-reminder-bot","owner":"wordpress-mobile","description":"GitHub bot that drops a comment to the PR about what to test when a specific file changes in gutenberg repo. Test cases and configurations live in gutenberg-tests repo.","archived":false,"fork":false,"pushed_at":"2023-03-15T23:11:07.000Z","size":626,"stargazers_count":3,"open_issues_count":3,"forks_count":0,"subscribers_count":26,"default_branch":"trunk","last_synced_at":"2025-01-13T18:23:15.056Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wordpress-mobile.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"publiccode":null,"codemeta":null}},"created_at":"2019-11-05T10:17:59.000Z","updated_at":"2021-02-18T22:40:48.000Z","dependencies_parsed_at":"2024-11-14T03:26:10.975Z","dependency_job_id":"90644883-ad59-45bb-a28d-c4fd86c1433c","html_url":"https://github.com/wordpress-mobile/test-case-reminder-bot","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wordpress-mobile%2Ftest-case-reminder-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wordpress-mobile%2Ftest-case-reminder-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wordpress-mobile%2Ftest-case-reminder-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wordpress-mobile%2Ftest-case-reminder-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wordpress-mobile","download_url":"https://codeload.github.com/wordpress-mobile/test-case-reminder-bot/tar.gz/refs/heads/trunk","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241622613,"owners_count":19992504,"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-11-14T03:24:23.295Z","updated_at":"2026-05-31T01:31:19.772Z","avatar_url":"https://github.com/wordpress-mobile.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Test Case Reminder Bot\n\nA GitHub bot that drops a comment into the PR about what to test when specific files change. It is done by providing source file to test-suite mapping, and the test-suite files itself.\n\n![Screenshot](screenshot.png)\n\n## Configuration\n\nBy default, this bot will look into [wordpress-mobile/test-cases repo](https://github.com/wordpress-mobile/test-cases) for test cases and [file mapping](https://github.com/wordpress-mobile/test-cases/blob/master/config/mapping.json).\n\nIt is possible to override default configuration by adding a `.github/test-case-reminder.json` into a repository where this bot is installed. Config accepts 3 parameters: \n\n- `tests_repo` - Repository with test suites and `mapping.json`\n- `tests_dir` - Path to test-suites directory\n- `mapping_file` - Path to `mapping.json` file\n- `comment_footer` - Markdown-formatted text that will be added _after_ list of test cases. Useful for suggestions on how to improve/extend existing test cases\n\nExample config:\n\n```json\n{\n  \"tests_repo\": \"brbrr/jetpack\",\n  \"tests_dir\": \"docs/regression-checklist/test-suites/\",\n  \"mapping_file\": \"docs/regression-checklist/mapping.json\",\n  \"comment_footer\": \"Text explaining how to extend and improve existing test suites\"\n}\n```\n\n## Contribution\n\n### Install\n\nTo run the code, make sure you have [Bundler](http://gembundler.com/) installed; then enter `bundle install` on the command line.\n\n### Set environment variables\n\n1. Create a copy of the `.env-example` file called `.env`.\n2. Create a test app with the following permissions: \"Read access to code\", \"Read access to metadata\", \"Read and write access to pull requests\"\n3. Add your GitHub App's private key, app ID, and webhook secret to the `.env` file.\n\n### Run the server\n\n1. Run `bundle exec ruby server.rb` on the command line.\n2. View the default Sinatra app at `localhost:3000`.\n\n### Develop\n\n[This guide](https://developer.github.com/apps/quickstart-guides/setting-up-your-development-environment/) will walk through the steps needed to configure a GitHub App and run it on a server.\n\nAfter completing the necessary steps in the guide you can use this command in this directory to run the smee client(replacing `https://smee.io/4OcZnobezZzAyaw` with your own domain):\n\n\u003e smee --url https://smee.io/4OcZnobezZzAyaw --path /event_handler --port 3000\n\n### Reload Changes\n\nIf you want server to reload automatically as you save the file  you can start the server as below instead of using `ruby server.rb`:\n\n\u003e bundle exec rerun 'ruby server.rb'\n\n### Unit tests\n\nUnit tests live in `unittest.rb`\n\nIf you want to test potential changes to [mapping.json](https://github.com/wordpress-mobile/test-cases/blob/master/config/mapping.json) file you can first apply the changes to `test_mapping.json` in this repo and test in your local as explained below.\n\n- Checkout this repo\n- Change `test_mapping.json`\n- Change `unittests.rb` [this line](https://github.com/wordpress-mobile/test-case-reminder-bot/blob/e12c02305f31bf6c3c6d76f9f3d370c0b4703d3e/unittests.rb#L27) with the filenames you want to test with.\n- Change assertions accordingly\n\nRun below command to run unittests:\n\n\u003e ruby unittests.rb\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwordpress-mobile%2Ftest-case-reminder-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwordpress-mobile%2Ftest-case-reminder-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwordpress-mobile%2Ftest-case-reminder-bot/lists"}