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

update

Browse source
This commit is contained in:
Thomas Sauter 2025-10-22 21:41:18 +02:00
parent d33377a766
commit bac2f84fd2
Signed by: thomas.sauter
GPG key ID: 015161F81E6A3C65
1 changed files with 32 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

39
README.md
View file

@ -37,14 +37,20 @@ A standard single-repository project with a `package.json` file located at the r
A monorepo project based on Turborepo, with individual projects located under the `/apps/<PROJECT_ID>` directory. A monorepo project based on Turborepo, with individual projects located under the `/apps/<PROJECT_ID>` directory.
##### Vars (inherited)
| Key | Description | Required |
| ----------------- | ------------------ | -------- |
| `IMAGE_BASE_PATH` | Image base path | ✓ |
| `TURBO_TEAM` | Turbo repo team ID | |
| `TURBO_API` | Turbo repo api url | |
##### Inputs ##### Inputs
| Key | Description | Required | | Key | Description | Required |
| ------------------------- | ------------------------------- | -------- | | ------------------------- | ------------------------------- | -------- |
| `PACKAGE_WRITER_USERNAME` | User name of the package writer | ✓ | | `PACKAGE_WRITER_USERNAME` | User name of the package writer | ✓ |
| `PROJECT_ID` | ID of the projcet | ✓ | | `PROJECT_ID` | ID of the projcet | ✓ |
| `TURBO_TEAM` | Turbo repo team ID | |
| `TURBO_API` | Turbo repo API | |
##### Secrets ##### Secrets
@ -54,13 +60,32 @@ A monorepo project based on Turborepo, with individual projects located under th
| `TURBO_TOKEN` | Access token for turbo cache | | | `TURBO_TOKEN` | Access token for turbo cache | |
| `FONTAWESOME_PACKAGE_TOKEN` | Fontawesome Pro library token (Only if fa in use ) | | | `FONTAWESOME_PACKAGE_TOKEN` | Fontawesome Pro library token (Only if fa in use ) | |
### `Lint`
Linting, type checking, sonarqube, dependency tracking, any testing
##### Vars (inherited) ##### Vars (inherited)
| Key | Description | Required | | Key | Description | Required |
| ----------------- | ------------------ | -------- | | ------------ | ------------------------------------------------- | -------- |
| `IMAGE_BASE_PATH` | Image base path | ✓ | | `TURBO_TEAM` | Turbo repo team ID (only applicable on monorepos) | |
| `TURBO_TEAM` | Turbo repo team ID | | | `TURBO_API` | Turbo repo api url (only applicable on monorepos) | |
| `TURBO_API` | Turbo repo api url | |
##### Inputs
| Key | Description | Required |
| ------------------- | ----------------------------------------------------------------------------------- | -------- |
| `SONARQUBE_ENABLED` | Send source to sonarqube for code analysis; 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`) | |
##### Secrets
| Key | Description | Required |
| --------------------------- | -------------------------------------------------- | -------- |
| `PACKAGE_WRITE_TOKEN` | Access token of the package writer | ✓ |
| `TURBO_TOKEN` | Access token for turbo cache | |
| `FONTAWESOME_PACKAGE_TOKEN` | Fontawesome Pro library token (Only if fa in use ) | |
## Authors ## Authors