Skip to content

Commit

Permalink
comma-separated
Browse files Browse the repository at this point in the history
  • Loading branch information
freddydk committed Nov 27, 2023
1 parent 305bd59 commit abdc96b
Show file tree
Hide file tree
Showing 10 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion Actions/Deliver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Deliver App to deliveryTarget (AppSource, Storage, or...)
| actor | | The GitHub actor running the action | github.actor |
| token | | The GitHub token running the action | github.token |
| parentTelemetryScopeJson | | Specifies the parent telemetry scope for the telemetry signal | {} |
| projects | | Comma separated list of projects to deliver | * |
| projects | | Comma-separated list of projects to deliver | * |
| deliveryTarget | Yes | Delivery target (AppSource, Storage, GitHubPackages,...) | |
| artifacts | Yes | The artifacts to deliver | |
| type | | Type of delivery (CD or Release) | CD |
Expand Down
2 changes: 1 addition & 1 deletion Actions/Deploy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Deploy Apps to online environment
| shell | | The shell (powershell or pwsh) in which the PowerShell script in this action should run | powershell |
| token | | The GitHub token running the action | github.token |
| parentTelemetryScopeJson | | Specifies the parent telemetry scope for the telemetry signal | {} |
| projects | | Comma separated list of projects to deploy. | |
| projects | | Comma-separated list of projects to deploy. | |
| environmentName | Yes | Name of environment to deploy to |
| artifacts | Yes | Artifacts to deploy |
| type | | Type of delivery (CD or Release) | CD |
Expand Down
2 changes: 1 addition & 1 deletion Actions/DetermineDeliveryTargets/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@ Determines the delivery targets to use for the build
| Name | Description |
| :-- | :-- |
| deliveryTargets | Compressed JSON array containing all delivery targets to use for the build |
| contextSecrets | A comma separated string with the names of the secrets to pass to ReadSecrets |
| contextSecrets | A comma-separated string with the names of the secrets to pass to ReadSecrets |

### ENV variables
2 changes: 1 addition & 1 deletion Actions/DetermineDeliveryTargets/action.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ outputs:
description: An array of Delivery Targets in compressed JSON format
value: ${{ steps.determineDeliveryTargets.outputs.DeliveryTargetsJson }}
ContextSecrets:
description: A comma seperated list of Context Secret names used
description: A comma-seperated list of Context Secret names used
value: ${{ steps.determineDeliveryTargets.outputs.ContextSecrets }}
runs:
using: composite
Expand Down
2 changes: 1 addition & 1 deletion Actions/ReadSecrets/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Secrets, which name is preceded by an asterisk (*) are encrypted and Base64 enco
| :-- | :-: | :-- | :-- |
| shell | | The shell (powershell or pwsh) in which the PowerShell script in this action should run | powershell |
| parentTelemetryScopeJson | | Specifies the parent telemetry scope for the telemetry signal | {} |
| getSecrets | Yes | Comma separated list of secrets to get (add appDependencyProbingPathsSecrets to request secrets needed for resolving dependencies in AppDependencyProbingPaths, add TokenForPush in order to request a token to use for pull requests and commits). Secrets preceded by an asterisk are returned encrypted | |
| getSecrets | Yes | Comma-separated list of secrets to get (add appDependencyProbingPathsSecrets to request secrets needed for resolving dependencies in AppDependencyProbingPaths, add TokenForPush in order to request a token to use for pull requests and commits). Secrets preceded by an asterisk are returned encrypted | |
| useGhTokenWorkflowForPush | false | Determines whether you want to use the GhTokenWorkflow secret for TokenForPush |

## OUTPUT
Expand Down
2 changes: 1 addition & 1 deletion Actions/ReadSecrets/ReadSecrets.ps1
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Param(
[Parameter(HelpMessage = "All GitHub Secrets in compressed JSON format", Mandatory = $true)]
[string] $gitHubSecrets = "",
[Parameter(HelpMessage = "Comma separated list of Secrets to get. Secrets preceded by an asterisk are returned encrypted", Mandatory = $true)]
[Parameter(HelpMessage = "Comma-separated list of Secrets to get. Secrets preceded by an asterisk are returned encrypted", Mandatory = $true)]
[string] $getSecrets = "",
[Parameter(HelpMessage = "Determines whether you want to use the GhTokenWorkflow secret for TokenForPush", Mandatory = $false)]
[string] $useGhTokenWorkflowForPush = 'false'
Expand Down
2 changes: 1 addition & 1 deletion Actions/ReadSecrets/action.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ inputs:
description: All GitHub Secrets in compressed JSON format
required: true
getSecrets:
description: Comma separated list of Secrets to get. Secrets preceded by an asterisk are returned encrypted
description: Comma-separated list of Secrets to get. Secrets preceded by an asterisk are returned encrypted
required: true
useGhTokenWorkflowForPush:
description: Determines whether you want to use the GhTokenWorkflow secret for TokenForPush
Expand Down
2 changes: 1 addition & 1 deletion Scenarios/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ The repository settings are only read from the repository settings file (.github
| <a id="githubRunnerShell"></a>githubRunnerShell | Specifies which shell is used for build jobs in workflows including a build job. The default is to use the same as defined in **shell**. If the shell setting isn't defined, **powershell** is the default, which results in using _PowerShell 5.1_. Use **pwsh** for _PowerShell 7_. |
| <a id="environments"></a>environments | Array of logical environment names. You can specify environments in GitHub environments or in the repo settings file. If you specify environments in the settings file, you can create your AUTHCONTEXT secret using **&lt;environmentname&gt;_AUTHCONTEXT**. You can specify additional information about environments in a setting called **DeployTo&lt;environmentname&gt;** | [ ] |
| <a id="deliverto"></a>DeliverTo&lt;deliveryTarget&gt; | Structure with additional properties for the deliveryTarget specified. Some properties are deliveryTarget specific. The structure can contain the following properties:<br />**Branches** = an array of branch patterns, which are allowed to deliver to this deliveryTarget. (Default main)<br />**CreateContainerIfNotExist** = *[Only for DeliverToStorage]* Create Blob Storage Container if it doesn't already exist. (Default false)<br /> | { } |
| <a id="deployto"></a>DeployTo&lt;environmentname&gt; | Structure with additional properties for the environment specified. The structure can contain the following properties:<br />**EnvironmentType** = specifies the type of environment. The environment type can be used to invoke a custom deployment. (Default SaaS)<br />**EnvironmentName** = specifies the "real" name of the environment if it differs from the GitHub environment.<br />**Branches** = an array of branch patterns, which are allowed to deploy to this environment. (Default main)<br />**Projects** = In multi-project repositories, this property can be a comma separated list of project patterns to deploy to this environment. (Default *)<br />**SyncMode** = ForceSync if deployment to this environment should happen with ForceSync, else Add. If deploying to the development endpoint you can also specify Development or Clean. (Default Add)<br />**ContinuousDeployment** = true if this environment should be used for continuous deployment, else false. (Default: AL-Go will continuously deploy to sandbox environments or environments, which doesn't end in (PROD) or (FAT)<br />**runs-on** = specifies which runner to use when deploying to this environment. (Default is settings.runs-on)<br /> | { } |
| <a id="deployto"></a>DeployTo&lt;environmentname&gt; | Structure with additional properties for the environment specified. The structure can contain the following properties:<br />**EnvironmentType** = specifies the type of environment. The environment type can be used to invoke a custom deployment. (Default SaaS)<br />**EnvironmentName** = specifies the "real" name of the environment if it differs from the GitHub environment.<br />**Branches** = an array of branch patterns, which are allowed to deploy to this environment. (Default main)<br />**Projects** = In multi-project repositories, this property can be a comma-separated list of project patterns to deploy to this environment. (Default *)<br />**SyncMode** = ForceSync if deployment to this environment should happen with ForceSync, else Add. If deploying to the development endpoint you can also specify Development or Clean. (Default Add)<br />**ContinuousDeployment** = true if this environment should be used for continuous deployment, else false. (Default: AL-Go will continuously deploy to sandbox environments or environments, which doesn't end in (PROD) or (FAT)<br />**runs-on** = specifies which runner to use when deploying to this environment. (Default is settings.runs-on)<br /> | { } |
| <a id="useProjectDependencies"></a>useProjectDependencies | Determines whether your projects are built using a multi-stage built workflow or single stage. After setting useProjectDependencies to true, you need to run Update AL-Go System Files and your workflows including a build job will change to have multiple build jobs, depending on each other. The number of build jobs will be determined by the dependency depth in your projects.<br />You can change dependencies between your projects, but if the dependency **depth** changes, AL-Go will warn you that updates for your AL-Go System Files are available and you will need to run the workflow. |
| <a id="CICDPushBranches"></a>CICDPushBranches | CICDPushBranches can be specified as an array of branches, which triggers a CI/CD workflow on commit.<br />Default is [ "main", "release/\*", "feature/\*" ] |
| <a id="CICDPullrequestBranches"></a>CICDPullRequestBranches | CICDPullRequestBranches can be specified as an array of branches, which triggers a CI/CD workflow on a PR.<br />Default is [ "main" ] |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ on:
workflow_dispatch:
inputs:
projects:
description: Comma seperated list of project name patterns if the repository is setup for multiple projects (default is * for all projects)
description: Comma-seperated list of project name patterns if the repository is setup for multiple projects (default is * for all projects)
required: false
default: '*'
versionNumber:
Expand Down
2 changes: 1 addition & 1 deletion Tests/DetermineDeliveryTargets.Test.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Describe "DetermineDeliveryTargets Action Test" {
}
$outputs = [ordered]@{
"DeliveryTargetsJson" = "An array of Delivery Targets in compressed JSON format"
"ContextSecrets" = "A comma seperated list of Context Secret names used"
"ContextSecrets" = "A comma-seperated list of Context Secret names used"
}
YamlTest -scriptRoot $scriptRoot -actionName $actionName -actionScript $actionScript -permissions $permissions -outputs $outputs
}
Expand Down

0 comments on commit abdc96b

Please sign in to comment.