chore: update readme
This commit is contained in:
parent
d1564129b6
commit
6759809040
1 changed files with 12 additions and 2 deletions
14
README.md
14
README.md
|
|
@ -16,6 +16,8 @@ A standard single-repository project with a `package.json` file located at the r
|
|||
|
||||
##### Vars (inherited)
|
||||
|
||||
Setuped on org or repo level.
|
||||
|
||||
| Key | Description | Required |
|
||||
| ------------ | --------------- | -------- |
|
||||
| `IMAGE_PATH` | Image base path | ✓ |
|
||||
|
|
@ -28,6 +30,8 @@ A standard single-repository project with a `package.json` file located at the r
|
|||
|
||||
##### Secrets
|
||||
|
||||
Note: Secrets must be explicitly passed to workflows, even if they are defined at the repository or organization level. This is due to the way Forgejo handles secrets in workflows.
|
||||
|
||||
| Key | Description | Required |
|
||||
| --------------------------- | --------------------------------------------------------- | -------- |
|
||||
| `PACKAGE_WRITE_TOKEN` | Accesstoken of the package writer | ✓ |
|
||||
|
|
@ -39,6 +43,8 @@ A monorepo project based on Turborepo, with individual projects located under th
|
|||
|
||||
##### Vars (inherited)
|
||||
|
||||
Setuped on org or repo level.
|
||||
|
||||
| Key | Description | Required |
|
||||
| ----------------- | ------------------ | -------- |
|
||||
| `IMAGE_BASE_PATH` | Image base path | ✓ |
|
||||
|
|
@ -54,6 +60,8 @@ A monorepo project based on Turborepo, with individual projects located under th
|
|||
|
||||
##### Secrets
|
||||
|
||||
Note: Secrets must be explicitly passed to workflows, even if they are defined at the repository or organization level. This is due to the way Forgejo handles secrets in workflows.
|
||||
|
||||
| Key | Description | Required |
|
||||
| --------------------------- | -------------------------------------------------- | -------- |
|
||||
| `PACKAGE_WRITE_TOKEN` | Access token of the package writer | ✓ |
|
||||
|
|
@ -68,6 +76,8 @@ Linting, type checking, sonarqube, dependency tracking, any testing
|
|||
|
||||
##### Vars (inherited)
|
||||
|
||||
Setuped on org or repo level.
|
||||
|
||||
| Key | Description | Required |
|
||||
| ---------------- | ------------------------------------------------- | -------- |
|
||||
| `TURBO_TEAM` | Turbo repo team ID (only applicable on monorepos) | |
|
||||
|
|
@ -83,10 +93,10 @@ Linting, type checking, sonarqube, dependency tracking, any testing
|
|||
| `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
|
||||
|
||||
##### Secrets
|
||||
|
||||
Note: Secrets must be explicitly passed to workflows, even if they are defined at the repository or organization level. This is due to the way Forgejo handles secrets in workflows.
|
||||
|
||||
| Key | Description | Required |
|
||||
| --------------------------- | ----------------------------------------------------------- | -------- |
|
||||
| `TURBO_TOKEN` | Access token for turbo cache (only applicable on monorepos) | |
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue