A GitHub App built with Probot. This is to track performance of your website while you are still developing it. Install this app and get a webpage test key, you should be all set.
Note: For now, we are using the api key from the app. But each api key allows only 200 tests per day. So a plan is made to get the key from the user config file.
- Code is committed to Github.
- Deploying the code on to any environment, once the PR is opened.
- Require a webpage-test api key.(This will be encoded)
- Once a PR is opened, it is supposed to be deployed to any enviornment.
- Deployed url will be read by the tracker and test will be made against it.
- Once the test is triggered, a comment will be made on the PR with the test url. So you can always go directly to that url.
- After the test is done, specific metrics will be posted on to the PR.
- You can also set budgets for those metrics. For the metrics that have budgets available a comparison will be made.
- Report will also be posted to Sentry if configured.
### Sample images
Post about starting the test
Report posted after the test
- Create performance_tracker_config.yml in your ./github folder.
- Configure it as explained here.
- Get a webpage api key from here.
- Encode it here and add it to the config yml file.
More about possible metrics here
# Install dependencies
yarn install
# Run the bot
_Developemnt_
yarn run dev For a consumer of this app:
- Get a page where we can encode the api key and use it in the config file.
- Adding PWA metrics to the report.
- Making this to be available as a npm module.
- Running scheduled tests. Schedule can be set via config file
- Running tests against a standard url.
- Sending reports to email.
For a developer:
- Improve on error logging
- Introduce background workers to ensure every event is handled
- Track rate limiting on the events and report to user if they are reaching the limit.
If you have suggestions for how performance-tracker could be improved, or want to report a bug, open an issue! We'd love all and any contributions.
For more, check out the Contributing Guide.
ISC © 2019 Prasanna Gaddam prasanna.virigineni@gmail.com