Skip to content

Commit 7d8616a

Browse files
committed
chore: fixing readme and update proper project id
1 parent 3ce8055 commit 7d8616a

File tree

2 files changed

+25
-21
lines changed

2 files changed

+25
-21
lines changed

.github/workflows/test.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,4 +42,4 @@ jobs:
4242
env:
4343
CURRENTS_RECORD_KEY: ${{ secrets.CURRENTS_RECORD_KEY }}
4444
run: |
45-
CURRENTS_API_URL=https://cy-staging.currents.dev/ npx currents upload --project-id DVKGcA --ci-build-id ${{ github.repository }}-${{ github.run_id }}-${{ github.run_attempt }}
45+
CURRENTS_API_URL=https://cy-staging.currents.dev/ npx currents upload --project-id JOw2i3 --ci-build-id ${{ github.repository }}-${{ github.run_id }}-${{ github.run_attempt }}

README.md

+24-20
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,24 @@
1-
This folder contains a suite of tests designed to validate the functionality of the Node Test Reporter and ensure its compatibility with the Currents API.
2-
3-
## Usage
4-
5-
1. Install the dependencies:
6-
```bash
7-
npm install
8-
```
9-
2. Run the tests:
10-
```bash
11-
npm run test
12-
```
13-
3. Convert the report to Currents format:
14-
```bash
15-
npm run convert
16-
```
17-
4. Report the results to the Currents API:
18-
```bash
19-
CURRENTS_PROJECT_ID=xxx CURRENTS_RECORD_KEY=xxx npm run report
20-
```
1+
# Currents + Node.js on GitHub Actions Example
2+
3+
## About
4+
5+
This repository demonstrates how to report test results generated by Node.js to [Currents](https://currents.dev) - a cloud platform for debugging, troubleshooting and analyzing CI tests.
6+
7+
8+
## How to reproduce
9+
10+
Follow the steps to reproduce this example:
11+
12+
- Create an account at https://app.currents.dev and obtain Project Id and Record Key
13+
- Save the Record Key as [Repository Secret](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions) `CURRENTS_RECORD_KEY`
14+
- Add `@currents/cmd` and `@currents/node-test-reporter` as a dependency
15+
- Configure GitHub actions [workflow](.github/workflows/test.yml):
16+
- run the tests: `npm run test`
17+
- convert the results using `npm run convert`
18+
- upload the test results to Currents: `npx currents upload`
19+
20+
## Resources
21+
22+
- 📖 [Currents documentation](https://docs.currents.dev)
23+
- [`@currents/cmd`](https://docs.currents.dev/resources/reporters/currents-cmd)
24+
- [`@currents/node-test-reporter`](https://docs.currents.dev/resources/reporters/currents-node-test-reporter)

0 commit comments

Comments
 (0)