Skip to content

Testing and Actions

Jump to bottom
Yash Khare edited this page Nov 27, 2020 · 2 revisions

Testing and Actions

Testing 🧰

We have implemented testing for a few functions of the CLI App, namely the commit generation and branch generation features since those are the most important features. The tests have been done using jest.

To run the tests locally, use:

npm test

The tests are located in the test folder.

00

Actions 🎯

To ensure that the tests are run and nothing is broken for each PR we are also making use of GitHub Actions. We are using the following actions:

  • NodeJS CI: This CI is for running the npm test command to ensure the CLI App works as expected after each and every PR.

  • Synk: This action is run in order to filter out any vulnerabilities having a high concern.

  • Prettier Linter: To ensure that the code stays readable, we use Prettier to format it. The action will automatically fix any lint issues in the files changed and commit them.

  • Release Drafter: To keep track of all changes made from one release to another, we use this action. Now we just need to press the publish release button when we need to make a release and the entire changelog is maintained by the GitHub Action.

Copyright (C) 2020 Rachit Gupta, Yash Khare, Shambhavi Aggarwal, and Preet Shah is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".

Link to the package on NPM: https://www.npmjs.com/package/gitg0 🚀

Clone this wiki locally