From bac2f84fd201336042affdcd9498ca0717c590f2 Mon Sep 17 00:00:00 2001 From: Thomas Sauter Date: Wed, 22 Oct 2025 21:41:18 +0200 Subject: [PATCH] update --- README.md | 39 ++++++++++++++++++++++++++++++++------- 1 file changed, 32 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index b74d3f5..9772719 100644 --- a/README.md +++ b/README.md @@ -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/` 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 | Key | Description | Required | | ------------------------- | ------------------------------- | -------- | | `PACKAGE_WRITER_USERNAME` | User name of the package writer | ✓ | | `PROJECT_ID` | ID of the projcet | ✓ | -| `TURBO_TEAM` | Turbo repo team ID | | -| `TURBO_API` | Turbo repo API | | ##### Secrets @@ -54,13 +60,32 @@ A monorepo project based on Turborepo, with individual projects located under th | `TURBO_TOKEN` | Access token for turbo cache | | | `FONTAWESOME_PACKAGE_TOKEN` | Fontawesome Pro library token (Only if fa in use ) | | +### `Lint` + +Linting, type checking, sonarqube, dependency tracking, any testing + ##### Vars (inherited) -| Key | Description | Required | -| ----------------- | ------------------ | -------- | -| `IMAGE_BASE_PATH` | Image base path | ✓ | -| `TURBO_TEAM` | Turbo repo team ID | | -| `TURBO_API` | Turbo repo api url | | +| Key | Description | Required | +| ------------ | ------------------------------------------------- | -------- | +| `TURBO_TEAM` | Turbo repo team ID (only applicable on monorepos) | | +| `TURBO_API` | Turbo repo api url (only applicable on monorepos) | | + +##### 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