Skip to content

Commit 7b71021

Browse files
docs(readme): update badges and workflow patterns (#68)
1 parent 5bb4aab commit 7b71021

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# LizardByte re-usable actions
22

33
[![GitHub Workflow Status (CI)](https://img.shields.io/github/actions/workflow/status/lizardbyte/actions/ci.yml.svg?branch=master&label=CI%20build&logo=github&style=for-the-badge)](https://github.com/LizardByte/actions/actions/workflows/ci.yml?query=branch%3Amaster)
4+
[![GitHub Workflow Status (CI-Tests)](https://img.shields.io/github/actions/workflow/status/lizardbyte/actions/ci-tests.yml.svg?branch=master&label=CI%20tests&logo=github&style=for-the-badge)](https://github.com/LizardByte/actions/actions/workflows/ci-tests.yml?query=branch%3Amaster)
45
[![Codecov](https://img.shields.io/codecov/c/gh/LizardByte/actions.svg?token=GQm8qlXRaw&style=for-the-badge&logo=codecov&label=codecov)](https://app.codecov.io/gh/LizardByte/actions)
6+
[![Sonar Quality Gate](https://img.shields.io/sonar/quality_gate/LizardByte_actions?server=https%3A%2F%2Fsonarcloud.io&style=for-the-badge&logo=sonarqubecloud&label=sonarqube)](https://sonarcloud.io/project/overview?id=LizardByte_actions)
57

68
This is a monorepo containing a collection of GitHub Actions maintained by LizardByte.
79

@@ -30,15 +32,15 @@ See our [Contributor's Guide](https://docs.lizardbyte.dev/latest/developers/code
3032

3133
This repo has two workflows to test the actions:
3234

33-
- ci.yml
35+
- [ci.yml](.github/workflows/ci.yml)
3436
- A matrix is generated for each action based on the `ci-matrix.json` file in the action's directory. To add or remove
3537
a matrix, edit the `ci-matrix.json` file.
3638
- Each action should have at least one matrix defined.
3739
- If anything needs run before the action is run, create a `pre-ci.sh` file in the action's directory.
3840
- If anything needs run after the action is run, create a `post-ci.sh` file in the action's directory.
39-
- pytest.yml
40-
- This workflow runs unit tests for the repo.
41-
- Python code should be 100% covered by tests.
41+
- [ci-tests.yml](.github/workflows/ci-tests.yml)
42+
- This workflow runs unit tests for the repo using pytest and Jest.
43+
- Tests should 100% cover JavaScript and Python code.
4244

4345
#### Action Types
4446

0 commit comments

Comments
 (0)