This applet allows you to track the status of GitHub Actions within a repository directly on your Das Keyboard Q. The applet gathers the response in one key, which changes color based on the overall status of the actions: orange when all actions are pending, green when all actions are successful, and red if any action fails.
Requires a Das Keyboard Q Series: www.daskeyboard.com
Installation, configuration, and uninstallation of applets are done within the Q Desktop application: https://www.daskeyboard.com/q
-
Install the dependencies:
yarn install
-
During the installation process, you will be asked to provide authentication information (API key) and select the repository you want to track.
Once the applet is running, it will automatically track the GitHub Actions in the specified repository and update the LED on your Das Keyboard Q accordingly.
You can change the repository being tracked by reinstalling the applet and selecting a different repository during the installation process.
This applet includes a test suite using Jest. To run the tests, use the following command:
yarn test
The test suite covers the different scenarios for GitHub Actions statuses (pending, successful, and failed) and ensures the applet behaves correctly.
For end-user documentation, please refer to the README_ENDUSER.md file.