Skip to content
Merged
4 changes: 2 additions & 2 deletions .github/actions/templates/getWorkflowInput/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ runs:
# Otherwise retrieve default values
else {
# Load used functions
. "$env:GITHUB_ACTION_PATH/scripts/Get-WorkflowDefaultInput.ps1"
. "$env:GITHUB_ACTION_PATH/scripts/Get-GitHubWorkflowDefaultInput.ps1"

$functionInput = @{
workflowPath = '${{ inputs.workflowPath }}'
Expand All @@ -75,7 +75,7 @@ runs:
Write-Verbose "Invoke task with" -Verbose
Write-Verbose ($functionInput | ConvertTo-Json | Out-String) -Verbose

$workflowParameters = Get-WorkflowDefaultInput @functionInput -Verbose
$workflowParameters = Get-GitHubWorkflowDefaultInput @functionInput -Verbose
$removeDeployment = $workflowParameters.removeDeployment
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Use this script to test a module from your PC locally, without a CI environment.
---
# Location

You can find the script under [`/utilities/tools/Test-ModuleLocally.ps1`](https://github.com/Azure/ResourceModules/blob/main/utilities/tools//Test-ModuleLocally.ps1)
You can find the script under [`/utilities/tools/Test-ModuleLocally.ps1`](https://github.com/Azure/ResourceModules/blob/main/utilities/tools/Test-ModuleLocally.ps1)

# How it works

Expand Down
28 changes: 28 additions & 0 deletions docs/wiki/Contribution guide - Validate module on scale.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
Use this script to tests multiple modules with a given branch, using the CI environment. The script will start the pipelines in the CI environment causing both static & deployment tests to run.

---

### _Navigation_

- [Location](#location)
- [How it works](#how-it-works)
- [How to use it](#how-to-use-it)

---
# Location

You can find the script under [`/utilities/tools/Invoke-PipelinesForBranch.ps1`](https://github.com/Azure/ResourceModules/blob/main/utilities/tools/Invoke-PipelinesForBranch.ps1)

# How it works

The most important parameter is the 'Environment' you want to run the pipelines for, that is, either GitHub or Azure DevOps. Depending on your choice you'll have to provide a Personal Access Token that grants the permissions to read & trigger pipelines in the desired environment.

Upon triggering, the utility will:
1. Fetch all pipelines in the target environment and filter them down to module pipelines by default.
1. Trigger these pipelines for the provided targeted branch (e.g. `main`)
1. Return the formatted status badges for the pipelines that were triggered.

# How to use it

For details on how to use the function, please refer to the script's local documentation.
> **Note:** The script must be loaded ('*dot-sourced*') before the function can be invoked.
1 change: 1 addition & 0 deletions docs/wiki/Contribution guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@ This section provides the step-by-step process we suggest to follow for contribu
- [Generate module Readme](./Contribution%20guide%20-%20Generate%20module%20Readme)
- [Get formatted RBAC roles](./Contribution%20guide%20-%20Get%20formatted%20RBAC%20roles)
- [Validate module locally](./Contribution%20guide%20-%20Validate%20module%20locally)
- [Validate modules on scale](./Contribution%20guide%20-%20Validate%20module%20on%20scale)
---
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ Retrieve input parameter default values for a specified workflow. Return hashtab
Mandatory. The path to the github workflow file.

.EXAMPLE
Get-WorkflowDefaultInput -workflowPath 'path/to/workflow' -verbose
Get-GitHubWorkflowDefaultInput -workflowPath 'path/to/workflow' -verbose

Retrieve input parameter default values for the 'path/to/workflow' workflow.
#>
function Get-WorkflowDefaultInput {
function Get-GitHubWorkflowDefaultInput {
[CmdletBinding()]
param (
[Parameter(Mandatory)]
Expand Down
Loading