| external help file | Module Name | online version | schema |
|---|---|---|---|
Pipelines.dll-Help.xml |
Pipelines |
2.0.0 |
A workflow is a configurable automated process made up of one or more jobs. You must create a YAML file to define your workflow configuration.
New-GhaWorkflow [-Name] <String> [[-RunName] <String>] [[-Jobs] <Job[]>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]A workflow is a configurable automated process made up of one or more jobs. You must create a YAML file to define your workflow configuration.
PS C:\> New-GhaWorkflow -Name 'MyWorkflow' -RunName 'my_workflow'
Name RunName Jobs
---- ------- ----
MyWorkflow my_workflow {}This creates a Workflow object on the Command line.
A workflow run is made up of one or more jobs, which run in parallel by default. To run jobs sequentially, you can define dependencies on other jobs using the jobs.<job_id>.needs keyword.
Each job runs in a runner environment specified by runs-on.
Type: ModPosh.Pipelines.Gha.Job[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe name of the workflow. GitHub displays the names of your workflows under your repository's "Actions" tab. If you omit name, GitHub displays the workflow file path relative to the root of the repository.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe name for workflow runs generated from the workflow. GitHub displays the workflow run name in the list of workflow runs on your repository's "Actions" tab. If run-name is omitted or is only whitespace, then the run name is set to event-specific information for the workflow run. For example, for a workflow triggered by a push or pull_request event, it is set as the commit message.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.