-
Notifications
You must be signed in to change notification settings - Fork 29
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: Updating Checkout Step to v4 ( Fixes #191 )
Updating workflow
- Loading branch information
StartAutomating
authored and
StartAutomating
committed
Sep 15, 2024
1 parent
6ee0897
commit fabf2a8
Showing
1 changed file
with
48 additions
and
180 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,279 +1,147 @@ | ||
| Convert-BuildStep | ||
| ----------------- | ||
|
|
||
| ### Synopsis | ||
| Converts Build Steps into build system input | ||
|
|
||
| --- | ||
|
|
||
| ### Description | ||
|
|
||
| Converts Build Steps defined in a PowerShell script into build steps in a build system | ||
|
|
||
| --- | ||
|
|
||
| ### Related Links | ||
| * [Import-BuildStep](Import-BuildStep.md) | ||
|
|
||
|
|
||
|
|
||
| * [Expand-BuildStep](Expand-BuildStep.md) | ||
|
|
||
|
|
||
|
|
||
| --- | ||
|
|
||
| ### Examples | ||
| #### EXAMPLE 1 | ||
| > EXAMPLE 1 | ||
| ```PowerShell | ||
| Get-Command Convert-BuildStep | Convert-BuildStep | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ### Parameters | ||
| #### **Name** | ||
|
|
||
| The name of the build step | ||
|
|
||
| |Type |Required|Position|PipelineInput | | ||
| |----------|--------|--------|---------------------| | ||
| |`[String]`|true |named |true (ByPropertyName)| | ||
|
|
||
|
|
||
| > **Type**: ```[String]``` | ||
| > **Required**: true | ||
| > **Position**: named | ||
| > **PipelineInput**:true (ByPropertyName) | ||
|
|
||
|
|
||
| --- | ||
| #### **ScriptBlock** | ||
|
|
||
| The Script Block that will be converted into a build step | ||
|
|
||
| |Type |Required|Position|PipelineInput | | ||
| |---------------|--------|--------|------------------------------| | ||
| |`[ScriptBlock]`|false |named |true (ByValue, ByPropertyName)| | ||
|
|
||
|
|
||
| > **Type**: ```[ScriptBlock]``` | ||
| > **Required**: false | ||
| > **Position**: named | ||
| > **PipelineInput**:true (ByValue, ByPropertyName) | ||
|
|
||
|
|
||
| --- | ||
| #### **Module** | ||
|
|
||
| The module that -ScriptBlock is declared in. If piping in a command, this will be bound automatically | ||
|
|
||
| |Type |Required|Position|PipelineInput | | ||
| |----------------|--------|--------|---------------------| | ||
| |`[PSModuleInfo]`|false |named |true (ByPropertyName)| | ||
|
|
||
|
|
||
| > **Type**: ```[PSModuleInfo]``` | ||
| > **Required**: false | ||
| > **Position**: named | ||
| > **PipelineInput**:true (ByPropertyName) | ||
|
|
||
|
|
||
| --- | ||
| #### **Path** | ||
|
|
||
| The path to the file | ||
|
|
||
| |Type |Required|Position|PipelineInput |Aliases | | ||
| |----------|--------|--------|---------------------|--------| | ||
| |`[String]`|false |named |true (ByPropertyName)|Fullname| | ||
|
|
||
|
|
||
| > **Type**: ```[String]``` | ||
| > **Required**: false | ||
| > **Position**: named | ||
| > **PipelineInput**:true (ByPropertyName) | ||
|
|
||
|
|
||
| --- | ||
| #### **Extension** | ||
|
|
||
| The extension of the file | ||
|
|
||
| |Type |Required|Position|PipelineInput | | ||
| |----------|--------|--------|---------------------| | ||
| |`[String]`|true |named |true (ByPropertyName)| | ||
|
|
||
|
|
||
| > **Type**: ```[String]``` | ||
| > **Required**: true | ||
| > **Position**: named | ||
| > **PipelineInput**:true (ByPropertyName) | ||
|
|
||
|
|
||
| --- | ||
| #### **InputParameter** | ||
|
|
||
| The name of parameters that should be supplied from event input. | ||
| Wildcards accepted. | ||
|
|
||
| |Type |Required|Position|PipelineInput |Aliases | | ||
| |---------------|--------|--------|---------------------|---------------| | ||
| |`[IDictionary]`|false |named |true (ByPropertyName)|InputParameters| | ||
|
|
||
|
|
||
| > **Type**: ```[IDictionary]``` | ||
| > **Required**: false | ||
| > **Position**: named | ||
| > **PipelineInput**:true (ByPropertyName) | ||
|
|
||
|
|
||
| --- | ||
| #### **VariableParameter** | ||
|
|
||
| The name of parameters that should be supplied from build variables. | ||
| Wildcards accepted. | ||
|
|
||
| |Type |Required|Position|PipelineInput |Aliases | | ||
| |------------|--------|--------|---------------------|------------------| | ||
| |`[String[]]`|false |named |true (ByPropertyName)|VariableParameters| | ||
|
|
||
|
|
||
| > **Type**: ```[String[]]``` | ||
| > **Required**: false | ||
| > **Position**: named | ||
| > **PipelineInput**:true (ByPropertyName) | ||
|
|
||
|
|
||
| --- | ||
| #### **EnvironmentParameter** | ||
|
|
||
| The name of parameters that should be supplied from the environment. | ||
| Wildcards accepted. | ||
|
|
||
| |Type |Required|Position|PipelineInput |Aliases | | ||
| |------------|--------|--------|---------------------|---------------------| | ||
| |`[String[]]`|false |named |true (ByPropertyName)|EnvironmentParameters| | ||
|
|
||
|
|
||
| > **Type**: ```[String[]]``` | ||
| > **Required**: false | ||
| > **Position**: named | ||
| > **PipelineInput**:true (ByPropertyName) | ||
|
|
||
|
|
||
| --- | ||
| #### **UniqueParameter** | ||
|
|
||
| The name of parameters that should be referred to uniquely. | ||
| For instance, if converting function foo($bar) {} and -UniqueParameter is 'bar' | ||
| The build parameter would be foo_bar. | ||
|
|
||
| |Type |Required|Position|PipelineInput |Aliases | | ||
| |------------|--------|--------|---------------------|----------------| | ||
| |`[String[]]`|false |named |true (ByPropertyName)|UniqueParameters| | ||
|
|
||
|
|
||
| > **Type**: ```[String[]]``` | ||
| > **Required**: false | ||
| > **Position**: named | ||
| > **PipelineInput**:true (ByPropertyName) | ||
|
|
||
|
|
||
| --- | ||
| #### **ExcludeParameter** | ||
|
|
||
| The name of parameters that should be excluded. | ||
|
|
||
| |Type |Required|Position|PipelineInput |Aliases | | ||
| |------------|--------|--------|---------------------|-----------------| | ||
| |`[String[]]`|false |named |true (ByPropertyName)|ExcludeParameters| | ||
|
|
||
|
|
||
| > **Type**: ```[String[]]``` | ||
| > **Required**: false | ||
| > **Position**: named | ||
| > **PipelineInput**:true (ByPropertyName) | ||
|
|
||
|
|
||
| --- | ||
| #### **DefaultParameter** | ||
|
|
||
| Default parameters for a build step | ||
|
|
||
| |Type |Required|Position|PipelineInput | | ||
| |---------------|--------|--------|---------------------| | ||
| |`[IDictionary]`|false |named |true (ByPropertyName)| | ||
|
|
||
|
|
||
| > **Type**: ```[IDictionary]``` | ||
| > **Required**: false | ||
| > **Position**: named | ||
| > **PipelineInput**:true (ByPropertyName) | ||
|
|
||
|
|
||
| --- | ||
| #### **BuildSystem** | ||
|
|
||
| The build system. Currently supported options, ADO and GitHub. Defaulting to ADO. | ||
|
|
||
|
|
||
|
|
||
| Valid Values: | ||
|
|
||
| * ADOPipeline | ||
| * ADOExtension | ||
| * GitHubWorkflow | ||
| * GitHubAction | ||
|
|
||
| |Type |Required|Position|PipelineInput| | ||
| |----------|--------|--------|-------------| | ||
| |`[String]`|false |named |false | | ||
|
|
||
|
|
||
| > **Type**: ```[String]``` | ||
| > **Required**: false | ||
| > **Position**: named | ||
| > **PipelineInput**:false | ||
|
|
||
|
|
||
| --- | ||
| #### **BuildOption** | ||
|
|
||
| Options for the build system. The can contain any additional parameters passed to the build system. | ||
|
|
||
|
|
||
|
|
||
| > **Type**: ```[PSObject]``` | ||
| > **Required**: false | ||
| > **Position**: named | ||
| > **PipelineInput**:false | ||
|
|
||
| |Type |Required|Position|PipelineInput| | ||
| |------------|--------|--------|-------------| | ||
| |`[PSObject]`|false |named |false | | ||
|
|
||
| --- | ||
|
|
||
| ### Outputs | ||
| * [Collections.IDictionary](https://learn.microsoft.com/en-us/dotnet/api/System.Collections.IDictionary) | ||
|
|
||
|
|
||
|
|
||
|
|
||
| --- | ||
|
|
||
| ### Syntax | ||
| ```PowerShell | ||
| Convert-BuildStep -Name <String> [-ScriptBlock <ScriptBlock>] [-Module <PSModuleInfo>] [-Path <String>] [-InputParameter <IDictionary>] [-VariableParameter <String[]>] [-EnvironmentParameter <String[]>] [-UniqueParameter <String[]>] [-ExcludeParameter <String[]>] [-DefaultParameter <IDictionary>] [-BuildSystem <String>] [-BuildOption <PSObject>] [<CommonParameters>] | ||
| ``` | ||
| ```PowerShell | ||
| Convert-BuildStep -Name <String> -Path <String> -Extension <String> [-InputParameter <IDictionary>] [-VariableParameter <String[]>] [-EnvironmentParameter <String[]>] [-UniqueParameter <String[]>] [-ExcludeParameter <String[]>] [-DefaultParameter <IDictionary>] [-BuildSystem <String>] [-BuildOption <PSObject>] [<CommonParameters>] | ||
| ``` | ||
| --- |