To get up and running quickly with CodeComet, follow these steps:
Create a CodeComet account
Navigate to https://app.codecomet.io/signup and create a new account.
Go to Settings > API Key and copy the pre-generated API Key for you. You will need to input this into the CLI app.
Install the CodeComet CLI app
Navigate to https://github.com/codecomet-io/cli/releases, then download the latest release zip file for your operating system. Unzip the file to your desired directory. This will create a
Here are the sample commands for downloading and installing the v1.1.0 of our Linux release (please modify as needed):
Run your test suite
First, set up an environment variable
CODECOMET_API_KEY with your API Key. For example:
Then, using the CodeComet CLI app, execute your test suite using a version of these example commands:
codecomet --suite "Sample Test Suite" -- go test ./...
pip install pytest-cov pytest-reportlog && codecomet --suite "Sample Test Suite" -- pytest
jest --ci --reporters=jest-junit && codecomet --suite "Sample Test Suite" junit junit.xml
For more details, please check out our Test Framework Guides.
View results in the CodeComet web app
Once your test suite has executed, go to https://app.codecomet.io/repos to view the results. Select the test suite run you'd like to inspect, and drill down into the particulars of each test.
Integrate CodeComet into your CI workflow
Once you are familiar with CodeComet’s CLI app, it’s time to incorporate it into your CI workflow.
For CircleCI, modify your
.circleci/config.yaml as follows:
For GitHub Actions, modify your
.github/workflows/workflow.yaml as follows:
For other CI systems, please visit our CI Integration Guides.
Set up your CodeComet web app
At this point, you’re pretty much good to go. Simply log back into the app at https://app.codecomet.io to view the results of your tests.
Once you’ve configured the CLI in your CI workflow, it’ll ingest test suite execution results on every run. You can choose to manually view these results at your convenience in the web app, or export them to a few different formats for further analysis.