Skip to content

Commit

Permalink
move ci readme, remove cov badge from workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
IkeHunter committed Oct 9, 2024
1 parent ef84feb commit 01e2141
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 18 deletions.
13 changes: 0 additions & 13 deletions .github/README.md

This file was deleted.

5 changes: 0 additions & 5 deletions .github/workflows/unit-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,3 @@ jobs:
run: npm ci
- name: Run Tests
run: npm run test
- name: Update Coverage Badge
# GitHub actions: default branch variable
# https://stackoverflow.com/questions/64781462/github-actions-default-branch-variable
if: github.ref == format('refs/heads/{0}', github.event.repository.default_branch)
uses: we-cli/coverage-badge-action@main
22 changes: 22 additions & 0 deletions docs/CI-CD.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# GitHub Action CI/CD

## Testing Locally

Use: **Act**
Source: <https://www.freecodecamp.org/news/how-to-run-github-actions-locally/>

Running actions:

```sh
# In Jukebox-Frontend/
act
```

## Coverage

TODO: Add test coverage badge

Resources:

- <https://github.com/vitest-dev/vitest/issues/2288>
- <https://github.com/nystudio107/rollup-plugin-critical/blob/master/.github/workflows/node.js.yml>

0 comments on commit 01e2141

Please sign in to comment.