https://github.com/brightspace/unit-test-action

A GitHub action to run unit tests and help display failing tests
https://github.com/brightspace/unit-test-action

Last synced: 5 days ago
JSON representation

A GitHub action to run unit tests and help display failing tests

• Host: GitHub
• URL: https://github.com/brightspace/unit-test-action
• Owner: Brightspace
• Created: 2021-07-07T17:59:22.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-05-17T12:59:30.000Z (6 months ago)
• Last Synced: 2024-05-17T14:07:17.802Z (6 months ago)
• Language: JavaScript
• Size: 6.76 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# unit-test-action

This is a Github Action to run unit tests and display the failed tests in the `Files Changed` of PRs.

This action is a work in progress, it has been worked on during an inspiration sprint. It is not a 

completed project and has room for improvement.

## In case of problems

If the action does not work as expected or if it does not support a testing framework you would 

like to use, please open up an issue and message Louis Coste.

## Supported testing frameworks

Currently the supported testing frameworks are:

### Mocha

### Karma

In order to use this GtiHub Action with Karma you will need to add a package to your modules. 

Make sure to add `"karma-json-reporter": "^1.1"` to your `devDependencies`.

## Disclaimer

This tool uses the npm scripts and modifies them slightly to be able to parse the results.

The result is then parsed and it might not always contain the file location where errors happen.

## How to use

Add a workflow file to your repository using the following template.

- ``: Testing framework used in the `npm test` command

- ``: The npm script to run, without the `npm run`. (Defaults to `test`)

```

name: Test

on:

  push:

    branches: [ master ]

jobs:

  build:

    runs-on: ubuntu-latest

    timeout-minutes: 10

    steps:

    - uses: Brightspace/third-party-actions@actions/checkout

    - uses: Brightspace/[email protected]

      with:

        test-type:  # Without the angle brackets

        test-script:  # Without the angle brackets

        token: ${{ secrets.GITHUB_TOKEN }}

```

If you are using the `karma` testing framework then you also need to add 

`"karma-json-reporter": "^1.1"` to your `devDependencies`

## Versioning, Releasing & Deploying

All version changes should obey [semantic versioning](https://semver.org/) rules.

This repo uses the [semantic-release](https://github.com/BrightspaceUI/actions/tree/master/semantic-release) GitHub action to manage GitHub releases. The commit message format for initiating releases is specified in that [semantic-release](https://github.com/BrightspaceUI/actions/tree/master/semantic-release) GitHub action.

Supported commit prefixes:

| Commit prefix        | Version Increase |

| -------------------- | ---------------- |

| `fix:`               | `PATCH`          |

| `perf:`              | `PATCH`          |

| `feat:`              | `MINOR`          |

| `BREAKING CHANGE:`   | `MAJOR`          |

Example commit: `feat: Adding error page` will increment the `MINOR` version.