phoenix-oss/frontend-commons
0
0
Fork 0
Code Issues 1 Pull requests Projects Releases 2 Packages Wiki Activity Actions

chore: update readme

Browse source
This commit is contained in:
Thomas Sauter 2025-10-23 09:06:52 +02:00
parent e9ceac2b4b
commit 0501a2fd55
Signed by: thomas.sauter
GPG key ID: 015161F81E6A3C65
2 changed files with 12 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

8
.github/workflows/lint.yaml vendored
View file

@ -17,12 +17,12 @@ on:
TEST_SCRIPT: TEST_SCRIPT:
required: false required: false
type: string type: string
default: yarn run test --ci --passWithNoTests --coverage default: yarn run test
LINT_SCRIPT: LINT_SCRIPT:
required: false required: false
type: string type: string
default: yarn run lint --max-warnings=0 default: yarn run lint
TYPE_CHECKING_SCRIPT: CHECK_TYPES_SCRIPT:
required: false required: false
type: string type: string
default: yarn run check-types default: yarn run check-types
@ -68,7 +68,7 @@ jobs:
- name: Static type checking (TypeScript) - name: Static type checking (TypeScript)
run: | run: |
${{ inputs.TYPE_CHECKING_SCRIPT }} ${{ inputs.CHECK_TYPES_SCRIPT}}
- name: Run tests - name: Run tests
if: ${{ inputs.TESTS_ENABLED == true }} if: ${{ inputs.TESTS_ENABLED == true }}

6
README.md
View file

@ -87,11 +87,13 @@ Setuped on org or repo level.
##### Inputs ##### Inputs
| Key | Description | Required | | Key | Description | Required |
| ------------------- | ---------------------------------------------------------------------------------- | -------- | | -------------------- | ---------------------------------------------------------------------------------- | -------- |
| `SONARQUBE_ENABLED` | Send source to sonarqube for code analysis; default: `false` | | | `SONARQUBE_ENABLED` | Send source to sonarqube for code analysis; default: `false` | |
| `TESTS_ENABLED` | Enable test suites; default: `false` | | | `TESTS_ENABLED` | Enable test suites; default: `false` | |
| `SETUP_REPO_SCRIPT` | Script which runs after install for setting up the repo; default: `yarn run setup` | | | `SETUP_REPO_SCRIPT` | Script which runs after install for setting up the repo; default: `yarn run setup` | |
| `TEST_SCRIPT` | Script which runs when tests are enabled; default: `yarn run test:coverage:lcov` | | | `TEST_SCRIPT` | Script which runs when tests are enabled; default: `yarn run test` | |
| `LINT_SCRIPT` | Script which runs eslint; default: `yarn run lint` | |
| `CHECK_TYPES_SCRIPT` | Script which runs tsc type checking: `yarn run check-types` | |
##### Secrets ##### Secrets