en-US/PSRule.Rules.GitHub-help.xml

<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh">
  <command:command 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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
    <command:details>
      <command:name>Export-GitHubRuleData</command:name>
      <command:verb>Export</command:verb>
      <command:noun>GitHubRuleData</command:noun>
      <maml:description>
        <maml:para>Export GitHub repository configuration.</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Export configuration data from one or more GitHub repositories.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Export-GitHubRuleData</maml:name>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none">
          <maml:name>OutputPath</maml:name>
          <maml:description>
            <maml:para>The path to store generated JSON files containing configuration data.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
          <dev:type>
            <maml:name>String</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>Credential</maml:name>
          <maml:description>
            <maml:para>An optional credential to use against GitHub APIs. This parameter uses the credential password as a Personal Access Token (PAT), username is ignored. If not specified, unauthenticated access will be used. The data exported will be limited to the permissions of the credential used.</maml:para>
            <maml:para>Please note that the GitHub APIs are throttled aggressively for non-authenticated requests.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue>
          <dev:type>
            <maml:name>PSCredential</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="R">
          <maml:name>Repository</maml:name>
          <maml:description>
            <maml:para>The repository spec for one or more repositories to export configuration data for. Use `&lt;organization&gt;/&lt;repository_name&gt;` or `&lt;user&gt;/&lt;repository_name&gt;` to export a single repository. Multiple repositories can be exported by comma separating each. To export all repositories for a user or organization use `&lt;organization&gt;/` or `&lt;user&gt;/`.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue>
          <dev:type>
            <maml:name>String[]</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>UseGitHubToken</maml:name>
          <maml:description>
            <maml:para>Determines if the GITHUB_TOKEN environment variable is used as a credential.</maml:para>
          </maml:description>
          <dev:type>
            <maml:name>SwitchParameter</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>False</dev:defaultValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
        <maml:name>Credential</maml:name>
        <maml:description>
          <maml:para>An optional credential to use against GitHub APIs. This parameter uses the credential password as a Personal Access Token (PAT), username is ignored. If not specified, unauthenticated access will be used. The data exported will be limited to the permissions of the credential used.</maml:para>
          <maml:para>Please note that the GitHub APIs are throttled aggressively for non-authenticated requests.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue>
        <dev:type>
          <maml:name>PSCredential</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none">
        <maml:name>OutputPath</maml:name>
        <maml:description>
          <maml:para>The path to store generated JSON files containing configuration data.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="R">
        <maml:name>Repository</maml:name>
        <maml:description>
          <maml:para>The repository spec for one or more repositories to export configuration data for. Use `&lt;organization&gt;/&lt;repository_name&gt;` or `&lt;user&gt;/&lt;repository_name&gt;` to export a single repository. Multiple repositories can be exported by comma separating each. To export all repositories for a user or organization use `&lt;organization&gt;/` or `&lt;user&gt;/`.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue>
        <dev:type>
          <maml:name>String[]</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
        <maml:name>UseGitHubToken</maml:name>
        <maml:description>
          <maml:para>Determines if the GITHUB_TOKEN environment variable is used as a credential.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
        <dev:type>
          <maml:name>SwitchParameter</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>False</dev:defaultValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>None</maml:name>
        </dev:type>
        <maml:description>
          <maml:para></maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>System.IO.FileInfo</maml:name>
        </dev:type>
        <maml:description>
          <maml:para></maml:para>
        </maml:description>
      </command:returnValue>
      <command:returnValue>
        <dev:type>
          <maml:name>System.Management.Automation.PSObject</maml:name>
        </dev:type>
        <maml:description>
          <maml:para></maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <maml:alertSet>
      <maml:alert>
        <maml:para></maml:para>
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>-------------------------- Example 1 --------------------------</maml:title>
        <dev:code>Export-GitHubRuleData -Repository 'microsoft/PSRule';</dev:code>
        <dev:remarks>
          <maml:para>Exports repository configuration data for `microsoft/PSRule`.</maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
    <command:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>Online Version:</maml:linkText>
        <maml:uri>https://github.com/microsoft/PSRule.Rules.GitHub/blob/main/docs/commands/PSRule.Rules.GitHub/en-US/Export-GitHubRuleData.md</maml:uri>
      </maml:navigationLink>
    </command:relatedLinks>
  </command:command>
</helpItems>