diff --git a/Actions/Deliver/README.md b/Actions/Deliver/README.md index 18d7b61ac..dbd1a003f 100644 --- a/Actions/Deliver/README.md +++ b/Actions/Deliver/README.md @@ -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 | diff --git a/Actions/Deploy/README.md b/Actions/Deploy/README.md index 6f20095ca..7b4e24317 100644 --- a/Actions/Deploy/README.md +++ b/Actions/Deploy/README.md @@ -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 | diff --git a/Actions/DetermineDeliveryTargets/README.md b/Actions/DetermineDeliveryTargets/README.md index 19debf56e..4ce95f0d6 100644 --- a/Actions/DetermineDeliveryTargets/README.md +++ b/Actions/DetermineDeliveryTargets/README.md @@ -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 diff --git a/Actions/DetermineDeliveryTargets/action.yaml b/Actions/DetermineDeliveryTargets/action.yaml index d9516de34..1a3050933 100644 --- a/Actions/DetermineDeliveryTargets/action.yaml +++ b/Actions/DetermineDeliveryTargets/action.yaml @@ -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 diff --git a/Actions/ReadSecrets/README.md b/Actions/ReadSecrets/README.md index ac2df1a8b..720a313d6 100644 --- a/Actions/ReadSecrets/README.md +++ b/Actions/ReadSecrets/README.md @@ -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 diff --git a/Actions/ReadSecrets/ReadSecrets.ps1 b/Actions/ReadSecrets/ReadSecrets.ps1 index 08f40e3b8..12922e5d1 100644 --- a/Actions/ReadSecrets/ReadSecrets.ps1 +++ b/Actions/ReadSecrets/ReadSecrets.ps1 @@ -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' diff --git a/Actions/ReadSecrets/action.yaml b/Actions/ReadSecrets/action.yaml index fd6090aa1..adf5a75ca 100644 --- a/Actions/ReadSecrets/action.yaml +++ b/Actions/ReadSecrets/action.yaml @@ -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 diff --git a/Scenarios/settings.md b/Scenarios/settings.md index ed2b3a8e4..84e7fdb03 100644 --- a/Scenarios/settings.md +++ b/Scenarios/settings.md @@ -57,7 +57,7 @@ The repository settings are only read from the repository settings file (.github | 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_. | | 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 **<environmentname>_AUTHCONTEXT**. You can specify additional information about environments in a setting called **DeployTo<environmentname>** | [ ] | | DeliverTo<deliveryTarget> | Structure with additional properties for the deliveryTarget specified. Some properties are deliveryTarget specific. The structure can contain the following properties:
**Branches** = an array of branch patterns, which are allowed to deliver to this deliveryTarget. (Default main)
**CreateContainerIfNotExist** = *[Only for DeliverToStorage]* Create Blob Storage Container if it doesn't already exist. (Default false)
| { } | -| DeployTo<environmentname> | Structure with additional properties for the environment specified. The structure can contain the following properties:
**EnvironmentType** = specifies the type of environment. The environment type can be used to invoke a custom deployment. (Default SaaS)
**EnvironmentName** = specifies the "real" name of the environment if it differs from the GitHub environment.
**Branches** = an array of branch patterns, which are allowed to deploy to this environment. (Default main)
**Projects** = In multi-project repositories, this property can be a comma separated list of project patterns to deploy to this environment. (Default *)
**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)
**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)
**runs-on** = specifies which runner to use when deploying to this environment. (Default is settings.runs-on)
| { } | +| DeployTo<environmentname> | Structure with additional properties for the environment specified. The structure can contain the following properties:
**EnvironmentType** = specifies the type of environment. The environment type can be used to invoke a custom deployment. (Default SaaS)
**EnvironmentName** = specifies the "real" name of the environment if it differs from the GitHub environment.
**Branches** = an array of branch patterns, which are allowed to deploy to this environment. (Default main)
**Projects** = In multi-project repositories, this property can be a comma-separated list of project patterns to deploy to this environment. (Default *)
**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)
**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)
**runs-on** = specifies which runner to use when deploying to this environment. (Default is settings.runs-on)
| { } | | 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.
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. | | CICDPushBranches | CICDPushBranches can be specified as an array of branches, which triggers a CI/CD workflow on commit.
Default is [ "main", "release/\*", "feature/\*" ] | | CICDPullRequestBranches | CICDPullRequestBranches can be specified as an array of branches, which triggers a CI/CD workflow on a PR.
Default is [ "main" ] | diff --git a/Templates/AppSource App/.github/workflows/IncrementVersionNumber.yaml b/Templates/AppSource App/.github/workflows/IncrementVersionNumber.yaml index 8e0a243e7..de98d25fd 100644 --- a/Templates/AppSource App/.github/workflows/IncrementVersionNumber.yaml +++ b/Templates/AppSource App/.github/workflows/IncrementVersionNumber.yaml @@ -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: diff --git a/Tests/DetermineDeliveryTargets.Test.ps1 b/Tests/DetermineDeliveryTargets.Test.ps1 index c9c2fc64f..102ae1c9d 100644 --- a/Tests/DetermineDeliveryTargets.Test.ps1 +++ b/Tests/DetermineDeliveryTargets.Test.ps1 @@ -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 }