en-US/Workflows-Help.xml
|
<?xml version="1.0" encoding="utf-8"?> <helpItems xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" schema="maml" xmlns="http://msh"> <command:command> <command:details> <command:name>Get-GithubWorkflow</command:name> <maml:description> <maml:para>Gets GitHub Actions workflows from a repository.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>GithubWorkflow</command:noun> </command:details> <maml:description> <maml:para>Gets GitHub Actions workflows from a repository. Can retrieve a specific workflow by ID or list all workflows.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-GithubWorkflow</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>RepositoryId</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Select</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MaxPages</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">uint</command:parameterValue> <dev:type> <maml:name>System.UInt32</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description /> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> </dev:type> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-GithubWorkflow</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="Id"> <maml:name>WorkflowId</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>RepositoryId</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Select</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MaxPages</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">uint</command:parameterValue> <dev:type> <maml:name>System.UInt32</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description /> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve all pages of results. Overrides MaxPages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>MaxPages</maml:name> <maml:description> <maml:para>Maximum number of pages of results to return. Each page contains up to 30 items.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.UInt32</command:parameterValue> <dev:type> <maml:name>System.UInt32</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="none"> <maml:name>RepositoryId</maml:name> <maml:description> <maml:para>The owner/name of the GitHub repository (e.g. 'owner/repo'). Defaults to the current directory's repository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Select</maml:name> <maml:description> <maml:para>Property name(s) to return. Use a comma-separated list for multiple properties, or '*' for all.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="Id"> <maml:name>WorkflowId</maml:name> <maml:description> <maml:para>The workflow ID or filename (e.g. 'ci.yml').</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.Object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>A string value.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Github.Workflow</maml:name> </dev:type> <maml:description> <maml:para>A GitHub Actions workflow object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>Get-GithubWorkflow Get-GithubWorkflow 'ci.yml'</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://docs.github.com/en/rest/actions/workflows</maml:linkText> <maml:uri>https://docs.github.com/en/rest/actions/workflows</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-GithubWorkflowJob</command:name> <maml:description> <maml:para>Gets jobs from a GitHub Actions workflow run.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>GithubWorkflowJob</command:noun> </command:details> <maml:description> <maml:para>Gets jobs from a GitHub Actions workflow run. Can retrieve a specific job by ID or list all jobs for a run.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-GithubWorkflowJob</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>WorkflowRunId</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>RepositoryId</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Select</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MaxPages</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">uint</command:parameterValue> <dev:type> <maml:name>System.UInt32</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description /> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> </dev:type> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-GithubWorkflowJob</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="Id"> <maml:name>WorkflowJobId</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>RepositoryId</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Select</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MaxPages</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">uint</command:parameterValue> <dev:type> <maml:name>System.UInt32</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description /> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve all pages of results. Overrides MaxPages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Filter jobs: 'latest' for the most recent execution or 'all' for every attempt.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>MaxPages</maml:name> <maml:description> <maml:para>Maximum number of pages of results to return. Each page contains up to 30 items.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.UInt32</command:parameterValue> <dev:type> <maml:name>System.UInt32</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="none"> <maml:name>RepositoryId</maml:name> <maml:description> <maml:para>The owner/name of the GitHub repository (e.g. 'owner/repo'). Defaults to the current directory's repository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Select</maml:name> <maml:description> <maml:para>Property name(s) to return. Use a comma-separated list for multiple properties, or '*' for all.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="Id"> <maml:name>WorkflowJobId</maml:name> <maml:description> <maml:para>The workflow job ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.Object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="none"> <maml:name>WorkflowRunId</maml:name> <maml:description> <maml:para>The workflow run ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.Object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>A string value.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para>Gets jobs from a GitHub Actions workflow run. Can retrieve a specific job by ID or list all jobs for a run.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Github.WorkflowJob</maml:name> </dev:type> <maml:description> <maml:para>A GitHub Actions workflow job object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>Get-GithubWorkflowRun | Get-GithubWorkflowJob</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://docs.github.com/en/rest/actions/workflow-jobs</maml:linkText> <maml:uri>https://docs.github.com/en/rest/actions/workflow-jobs</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-GithubWorkflowRun</command:name> <maml:description> <maml:para>Gets GitHub Actions workflow runs from a repository.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>GithubWorkflowRun</command:noun> </command:details> <maml:description> <maml:para>Gets GitHub Actions workflow runs from a repository. Can retrieve a specific run by ID or list runs with optional filtering by workflow, branch, status, and trigger event.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-GithubWorkflowRun</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>RepositoryId</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>WorkflowId</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Branch</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Status</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>EventName</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Select</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MaxPages</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">uint</command:parameterValue> <dev:type> <maml:name>System.UInt32</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description /> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> </dev:type> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-GithubWorkflowRun</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="Id"> <maml:name>WorkflowRunId</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>RepositoryId</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Select</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>MaxPages</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">uint</command:parameterValue> <dev:type> <maml:name>System.UInt32</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>All</maml:name> <maml:description /> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>All</maml:name> <maml:description> <maml:para>Retrieve all pages of results. Overrides MaxPages.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Branch</maml:name> <maml:description> <maml:para>Filter commits by branch name.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>EventName</maml:name> <maml:description> <maml:para>Filter workflow runs by the event that triggered them (e.g. push, pull_request).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>MaxPages</maml:name> <maml:description> <maml:para>Maximum number of pages of results to return. Each page contains up to 30 items.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.UInt32</command:parameterValue> <dev:type> <maml:name>System.UInt32</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="none"> <maml:name>RepositoryId</maml:name> <maml:description> <maml:para>The owner/name of the GitHub repository (e.g. 'owner/repo'). Defaults to the current directory's repository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Select</maml:name> <maml:description> <maml:para>Property name(s) to return. Use a comma-separated list for multiple properties, or '*' for all.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Status</maml:name> <maml:description> <maml:para>Filter workflow runs by status (e.g. completed, in_progress, success, failure).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="none"> <maml:name>WorkflowId</maml:name> <maml:description> <maml:para>The workflow ID or filename (e.g. 'ci.yml').</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.Object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="Id"> <maml:name>WorkflowRunId</maml:name> <maml:description> <maml:para>The workflow run ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.Object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>A string value.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para>Gets GitHub Actions workflow runs from a repository. Can retrieve a specific run by ID or list runs with optional filtering by workflow, branch, status, and trigger event.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Github.WorkflowRun</maml:name> </dev:type> <maml:description> <maml:para>A GitHub Actions workflow run object.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>Get-GithubWorkflowRun Get-GithubWorkflowRun -Status failure</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://docs.github.com/en/rest/actions/workflow-runs</maml:linkText> <maml:uri>https://docs.github.com/en/rest/actions/workflow-runs</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Get-GithubWorkflowRunLog</command:name> <maml:description> <maml:para>Gets the log output for a GitHub Actions workflow job.</maml:para> </maml:description> <command:verb>Get</command:verb> <command:noun>GithubWorkflowRunLog</command:noun> </command:details> <maml:description> <maml:para>Downloads and returns the log output for a specific GitHub Actions workflow job.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-GithubWorkflowRunLog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="Id"> <maml:name>WorkflowJobId</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>RepositoryId</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="none"> <maml:name>RepositoryId</maml:name> <maml:description> <maml:para>The owner/name of the GitHub repository (e.g. 'owner/repo'). Defaults to the current directory's repository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="Id"> <maml:name>WorkflowJobId</maml:name> <maml:description> <maml:para>The workflow job ID.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.Object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>A string value.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>A string value.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>Get-GithubWorkflowRunLog 12345</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://docs.github.com/en/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run</maml:linkText> <maml:uri>https://docs.github.com/en/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command> <command:details> <command:name>Start-GithubWorkflowRun</command:name> <maml:description> <maml:para>Triggers a GitHub Actions workflow run.</maml:para> </maml:description> <command:verb>Start</command:verb> <command:noun>GithubWorkflowRun</command:noun> </command:details> <maml:description> <maml:para>Dispatches a GitHub Actions workflow run. By default triggers on the repository's default branch. Use -Ref to target a specific branch or tag, and -Inputs to pass workflow input parameters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Start-GithubWorkflowRun</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="none"> <maml:name>WorkflowId</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>RepositoryId</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Ref</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Inputs</maml:name> <maml:description /> <command:parameterValue required="true" variableLength="false">hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>WhatIf</maml:name> <maml:description /> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>Confirm</maml:name> <maml:description /> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> </dev:type> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Inputs</maml:name> <maml:description> <maml:para>Hashtable of input key-value pairs to pass to the workflow.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.Collections.Hashtable</command:parameterValue> <dev:type> <maml:name>System.Collections.Hashtable</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="none"> <maml:name>Ref</maml:name> <maml:description> <maml:para>The git reference (branch name, tag, or SHA) to use.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="Named" aliases="none"> <maml:name>RepositoryId</maml:name> <maml:description> <maml:para>The owner/name of the GitHub repository (e.g. 'owner/repo'). Defaults to the current directory's repository.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Runs the command in a mode that only reports what would happen without performing the actions.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> </dev:type> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="0" aliases="none"> <maml:name>WorkflowId</maml:name> <maml:description> <maml:para>The workflow ID or filename (e.g. 'ci.yml').</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">System.Object</command:parameterValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>A string value.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para>Dispatches a GitHub Actions workflow run. By default triggers on the repository's default branch. Use -Ref to target a specific branch or tag, and -Inputs to pass workflow input parameters.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Void</maml:name> </dev:type> <maml:description> <maml:para>Dispatches a GitHub Actions workflow run. By default triggers on the repository's default branch. Use -Ref to target a specific branch or tag, and -Inputs to pass workflow input parameters.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------- Example 1 ---------</maml:title> <maml:introduction> <maml:para>Start-GithubWorkflowRun 'ci.yml'</maml:para> </maml:introduction> <dev:code /> <dev:remarks /> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>https://docs.github.com/en/rest/actions/workflows#create-a-workflow-dispatch-event</maml:linkText> <maml:uri>https://docs.github.com/en/rest/actions/workflows#create-a-workflow-dispatch-event</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |