GitHubCli

0.11.0

en-US/Commits-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-GithubCommit</command:name>

      <maml:description>

        <maml:para>Gets commits from a GitHub repository.</maml:para>

      </maml:description>

      <command:verb>Get</command:verb>

      <command:noun>GithubCommit</command:noun>

    </command:details>

    <maml:description>

      <maml:para>Gets commits from a GitHub repository. When a SHA is specified, retrieves detailed information for that commit. Otherwise, lists commits with optional filtering by branch, author, date range, and file path.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Get-GithubCommit</maml:name>

        <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="0" aliases="Ref">

          <maml:name>Sha</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>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>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>Author</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>Since</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>Until</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>Path</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: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: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>Author</maml:name>

        <maml:description>

          <maml:para>Filter by the author's GitHub username.</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>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>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="false" position="Named" aliases="none">

        <maml:name>Path</maml:name>

        <maml:description>

          <maml:para>Filter commits by file path.</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="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="Ref">

        <maml:name>Sha</maml:name>

        <maml:description>

          <maml:para>The commit SHA or ref to retrieve.</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>Since</maml:name>

        <maml:description>

          <maml:para>Only return results updated after the given ISO 8601 timestamp (YYYY-MM-DDTHH:MM:SSZ).</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>Until</maml:name>

        <maml:description>

          <maml:para>Only return commits before the given ISO 8601 timestamp.</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: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.Commit</maml:name>

        </dev:type>

        <maml:description>

          <maml:para>A GitHub commit 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-GithubCommit

Get-GithubCommit -Branch main -Author octocat</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/commits/commits</maml:linkText>

        <maml:uri>https://docs.github.com/en/rest/commits/commits</maml:uri>

      </maml:navigationLink>

    </command:relatedLinks>

  </command:command>

</helpItems>