Documentation and the code samples that are apart of them play an important role in a developer's experience. Code samples are the starting point for many developers and it's critical that they work in order for developers to gain a deeper understanding of the documentation as well as the technology itself.
This project aims to improve the quality of our code samples by running automated nightly integration tests on each repository referenced in documentation and then consolidating and presenting test results of all repositories on a dashboard. The goal was to take a proactive approach to ensuring all code samples work without wasting time manually testing each one.
V2 of this project implements the following:
- Data driven repo selection using github repository statistics
- Automated creation of issues upon playwright test failure
- Refactored code structure to allow for reuse of cmmon github workflows and othered shared code
You can view the live dashboard here Nightly Integration Tests Dashboard
Or you can watch the video here
To spin up a local copy of the dashboard Node.js version 16.14 or higher is required. Clone the repository and type the following commands:
npm install
npm startFor more detailed instructions on how to set up the test harness and dashboard please see Nightly Integration Tests Dashboard Documentation