From 382d4e7891db4f30611ab336fd04c5287d567cfe Mon Sep 17 00:00:00 2001 From: Oded Ben Ozer Date: Mon, 8 Apr 2024 13:56:56 +0200 Subject: [PATCH] Markdown syntax --- docs/installation.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/installation.md b/docs/installation.md index 344f3118..bdac47ce 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -85,11 +85,12 @@ Pulled from `telefonistka.yaml` file in the repo root directory(default branch) Configuration keys: + |key|desc| |---|---| |`promotionPaths`| Array of maps, each map describes a promotion flow| |`promotionPaths[0].sourcePath`| directory that holds components(subdirectories) to be synced, can include a regex.| -|`promotionPaths[0].componentPathExtraDepth`| The number of extra nesting levels to add to the "components" being promoted, this allows nesting components in subdirectories while keeping them distinct.
A `2` value will mean the component name includes the 3 subdirectories under the `sourcePath` | +|`promotionPaths[0].componentPathExtraDepth`| The number of extra nesting levels to add to the "components" being promoted, this allows nesting components in subdirectories while keeping them distinct.
A `2` value will mean the component name includes the 3 subdirectories under the `sourcePath`| |`promotionPaths[0].conditions` | conditions for triggering a specific promotion flows. Flows are evaluated in order, first one to match is triggered.| |`promotionPaths[0].conditions.prHasLabels` | Array of PR labels, if the triggering PR has any of these labels the condition is considered fulfilled. Currently it's the only supported condition type| |`promotionPaths[0].promotionPrs`| Array of structures, each element represent a PR that will be opened when files are changed under `sourcePath`. Multiple elements means multiple PR will be opened| @@ -97,6 +98,7 @@ Configuration keys: |`dryRunMode`| if true, the bot will just comment the planned promotion on the merged PR| |`autoApprovePromotionPrs`| if true the bot will auto-approve all promotion PRs, with the assumption the original PR was peer reviewed and is promoted verbatim. Required additional GH token via APPROVER_GITHUB_OAUTH_TOKEN env variable| |`toggleCommitStatus`| Map of strings, allow (non-repo-admin) users to change the [Github commit status](https://docs.github.com/en/rest/commits/statuses) state(from failure to success and back). This can be used to continue promotion of a change that doesn't pass repo checks. the keys are strings commented in the PRs, values are [Github commit status context](https://docs.github.com/en/rest/commits/statuses?apiVersion=2022-11-28#create-a-commit-status) to be overridden| + Example: