{"id":29624092,"url":"https://github.com/currents-dev/currents-reporter","last_synced_at":"2025-07-21T05:32:31.457Z","repository":{"id":269033272,"uuid":"823100504","full_name":"currents-dev/currents-reporter","owner":"currents-dev","description":"A collection of CLI tools reporting test results to Currents platform and for using Currents APIs.","archived":false,"fork":false,"pushed_at":"2025-07-07T16:29:23.000Z","size":1652,"stargazers_count":2,"open_issues_count":6,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-07-17T22:32:29.405Z","etag":null,"topics":["currents","reporting-services","test-automation","test-cases","test-reporting"],"latest_commit_sha":null,"homepage":"https://docs.currents.dev/getting-started/others","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/currents-dev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-07-02T12:26:54.000Z","updated_at":"2025-06-13T09:24:56.000Z","dependencies_parsed_at":"2024-12-20T13:23:42.955Z","dependency_job_id":"53dfe098-5944-4177-9e69-ed4b9c213f8e","html_url":"https://github.com/currents-dev/currents-reporter","commit_stats":null,"previous_names":["currents-dev/currents-reporter"],"tags_count":83,"template":false,"template_full_name":null,"purl":"pkg:github/currents-dev/currents-reporter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/currents-dev%2Fcurrents-reporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/currents-dev%2Fcurrents-reporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/currents-dev%2Fcurrents-reporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/currents-dev%2Fcurrents-reporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/currents-dev","download_url":"https://codeload.github.com/currents-dev/currents-reporter/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/currents-dev%2Fcurrents-reporter/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266244491,"owners_count":23898621,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["currents","reporting-services","test-automation","test-cases","test-reporting"],"created_at":"2025-07-21T05:32:30.409Z","updated_at":"2025-07-21T05:32:31.447Z","avatar_url":"https://github.com/currents-dev.png","language":"TypeScript","readme":"# currents-reporter\n\nA monorepo which contains the following packages:\n\n- `@currents/jest` - Currents jest reporter ([documentation](https://docs.currents.dev/resources/reporters/currents-jest)).\n- `@currents/cmd` - `currents` CLI command ([documentation](https://docs.currents.dev/resources/reporters/currents-cmd))\n- `@currents/node-test-reporter` - Currents Node.js test reporter\n- `examples` - a private package used to test the implementation\n\n## Develop and contribute\n- run `npm i`\n- run `npm run dev`\n\n* in case you would like to test the `examples` folder, please run the `npm link` command as well:\n- go the desired package. i.e. `cd packages/cmd`\n- run `npm link` - This will create a global symlink to the package.\n- go the desired examples folder. i.e. `cd examples/postman`\n- run `npm link @currents/cmd`.\n- Now you can call the `currents` command and it will call the local repo code.\n\nnotice: the `npm run dev` is compiling and building the package on each change, in case it is not running you will have to manually call the build command.\n\n\n## Testing locally\n\n- `npm i`\n- `npm run build`\n- `cd ./examples`\n\n#### Creating a report using Jest\n\n- `cd examples/jest`\n\nRun `npm run test` to run example spec files.\n\nIn order to test different scenarios, update the jest configuration by modifying the `jest.config.js` file or run the command with jest cli options.\n\nTo enable the debug mode, prefix the command with `DEBUG=currents-jest`\n\nFor a custom path for the report directory, set an absolute path to the `reportDir` option for to the reporter configuration:\n\n```javascript\n  reporters: [\n    // \"default\",\n    [\"@currents/jest\", {\n        reportDir: \"/home/slavic/Desktop/.jest-report\"\n    }],\n  ],\n```\n\n### Uploading the results\n\nSet the `projectId`, `recordKey` and optionally the `ciBuildId`. Run `npx currents upload --help` for details.\n\nRun `npm run report` or `CURRENTS_API_URL=http://localhost:1234 CURRENTS_PROJECT_ID=xxx CURRENTS_RECORD_KEY=yyy npx currents upload`\n\nTo enable the debug mode, prefix the command with `DEBUG=currents,currents:*` or use the `--debug` option.\n\nTo provide a custom report dir path, use `CURRENTS_REPORT_DIR` env variable or `--report-dir` option.\n\n### Obtaining run information\n\nRun `CURRENTS_REST_API_URL=http://localhost:4000 CURRENTS_PROJECT_ID=xxx npx currents api get-run --api-key \u003capi-key\u003e --ci-build-id \u003cci-build-id\u003e --output run.json`\n\nRun `npx currents api --help` to see all available api commands.\n\nTo explore additional examples and filtering options for receiving runs, you can utilize the `npx currents api get-run --help` command.\n\n### Caching artifacts\n\nThe `currents cache` command allows you to archive files from specified locations and save them under an ID in Currents storage. It also stores a meta file with configuration data. You can provide the ID manually or it can be generated based on CI environment variables (only GitHub, GitLab, and Circle CI are supported). The files to archive can be defined using the `path \u003cpath-1,path2,...,path-n\u003e` CLI option or predefined using a `preset`.\n\nTo cache files, run `npx currents cache set --key \u003crecord-key\u003e --id \u003cid\u003e --path \u003cpath-1,path-2,...path-n\u003e`.\n\nTo download files, run `npx currents cache get --key \u003crecord-key\u003e --id \u003cid\u003e`.\n\nFor more examples and usage options, run `npx currents cache --help`.\n\n## Release\n\nCreate and push new branch for release (to be merged to main after publishing). This is required because we don't accept pushes direct to main.\n\n```sh\n# git checkout -b release/{pkgname}-{version}\ngit checkout -b release/cmd-1.1.0\n```\n\nPush that branch to the repo. (It has to be present on the remote for `release-it` to run).\n\nRelease the package by running the release task which tags, and pushes the release.\n\n```sh\ncd ./packages/name\n\n# beta / alpha\n# npm run release -- minor|patch --preRelease=beta|alpha\nnpm run release\n```\n\nYou can create a PR from the release branch to be merged after publish.\n\n## Publishing\n\nDispatch the GitHub Actions Workflow to publish new releases: https://github.com/currents-dev/currents-reporter/actions/workflows/publish.yaml\n\nEnsure to point the workflow at the release branch OR tag if the release branch has not already been merged to main.\n\nAfter the publish is complete, the release branch PR should be merged to main.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcurrents-dev%2Fcurrents-reporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcurrents-dev%2Fcurrents-reporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcurrents-dev%2Fcurrents-reporter/lists"}