diff --git a/README.md b/README.md index 77338fde..79081cda 100644 --- a/README.md +++ b/README.md @@ -123,16 +123,6 @@ For a failed test details table, add the `failed` command to your workflow yaml: if: always() ``` -### Generating Failed Folded Test Details Table - -For a failed test table with details folded, add the `failed-folded` command to your workflow yaml: - -```yaml -- name: Publish CTRF Failed Test Summary Results - run: npx github-actions-ctrf failed-folded path-to-your-ctrf-report.json - if: always() -``` - ### Generating Failed Rate Test Details Table To see the failed test rate over time, add the `failed-rate` command to your workflow yaml: @@ -181,6 +171,16 @@ To see which tests were skipped or pending, add the `skipped` command to your wo if: always() ``` +### Generating Suite Folded Table + +To see which tests grouped by suite with tests folkded, add the `suite-folded` command to your workflow yaml: + +```yaml +- name: Publish CTRF Suite Folded Summary + run: npx github-actions-ctrf suite-folded path-to-your-ctrf-report.json + if: always() +``` + ### Generating Previous Tests Table To see results from previous tests, add the `historical` command to your workflow yaml: @@ -442,48 +442,6 @@ Overall Fail Rate across all tests is calculated by summing the fail counts and Overall Fail Rate (%) = (Total Fail Counts of All Tests ÷ Total Runs of All Tests) × 100 -## Alternative Installation Options - -### Locking to a Specific Version with `npx` - -The easiest way to run `github-actions-ctrf` is by using `npx`, which doesn't require installation. By default, it runs the latest version. However, if you'd like to lock to a specific version, you can do so by specifying the version: - -```bash -npx github-actions-ctrf@1.2.3 path-to-your-ctrf-report.json -``` - -This command will download and run the specified version of `github-actions-ctrf`. - -### Local Installation in Your Node.js Project - -For users who prefer installing the package locally to their project, you can install `github-actions-ctrf` as a project dependency: - -```bash -npm install github-actions-ctrf -``` - -This will install `github-actions-ctrf` into your `node_modules` folder, and you can run it with the following command: - -```bash -./node_modules/.bin/github-actions-ctrf path-to-your-ctrf-report.json -``` - -Alternatively, you can add a script to your `package.json` to simplify the command: - -```json -{ - "scripts": { - "report": "github-actions-ctrf path-to-your-ctrf-report.json" - } -} -``` - -Now, you can run: - -```bash -npm run report -``` - ## Components [Click here](https://github.com/ctrf-io/github-actions-ctrf/actions) to see the Actions of this repository for a full example @@ -500,13 +458,9 @@ npm run report ![Failed](images/failed.png) -### Failed Folded details - -![Failed Folded](images/failed-folded.png) - ### Failed rate -![Failed Rate](images/failed-rate.png) +![Failed](images/failed-rate.png) ### AI summary diff --git a/images/suite-folded.png b/images/suite-folded.png new file mode 100644 index 00000000..39659dba Binary files /dev/null and b/images/suite-folded.png differ diff --git a/package-lock.json b/package-lock.json index f6afe0c6..cbce290d 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "github-actions-ctrf", - "version": "0.0.46", + "version": "0.0.47", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "github-actions-ctrf", - "version": "0.0.46", + "version": "0.0.47", "license": "MIT", "dependencies": { "@actions/core": "^1.10.1", diff --git a/package.json b/package.json index e1eae0ca..f3c984fc 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "github-actions-ctrf", - "version": "0.0.46", + "version": "0.0.47", "description": "View test results directly within your GitHub workflow summary and Pull Requests", "main": "index.js", "scripts": {