en-US/Catesta-help.xml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
<?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>New-PowerShellProject</command:name>
      <command:verb>New</command:verb>
      <command:noun>PowerShellProject</command:noun>
      <maml:description>
        <maml:para>Scaffolds a PowerShell module project for use with desired CICD platform for easy cross platform PowerShell development.</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Leverages plaster to scaffold a PowerShell module that adheres to community best practices. Based on selections made this cmdlet will generate the necessary files for a variety of CICD platforms. Selections can also determine what CICD builds should be run enabling easy cross-platform verification (Windows/Linux/MacOS). InvokeBuild tasks will be created for validation / analysis / test / build automation. Additional selections can generate other helpful files such as GitHub community files and VSCode project files.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>New-PowerShellProject</maml:name>
        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">
          <maml:name>CICDChoice</maml:name>
          <maml:Description>
            <maml:para>CICD Platform Choice AWS - AWS CodeBuild GitHubActions - GitHub Actions Workflows Azure - Azure DevOps Pipelines AppVeyor - AppVeyor Projects ModuleOnly - Just a Vanilla PowerShell module scaffold</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="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none">
          <maml:name>DestinationPath</maml:name>
          <maml:Description>
            <maml:para>File path where PowerShell Module project will be created</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>Force</maml:name>
          <maml:Description>
            <maml:para>Skip Confirmation</maml:para>
          </maml:Description>
          <dev:type>
            <maml:name>SwitchParameter</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>False</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi">
          <maml:name>WhatIf</maml:name>
          <maml:Description>
            <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para>
          </maml:Description>
          <dev:type>
            <maml:name>SwitchParameter</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>False</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" 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>SwitchParameter</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>False</dev:defaultValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none">
        <maml:name>CICDChoice</maml:name>
        <maml:Description>
          <maml:para>CICD Platform Choice AWS - AWS CodeBuild GitHubActions - GitHub Actions Workflows Azure - Azure DevOps Pipelines AppVeyor - AppVeyor Projects ModuleOnly - Just a Vanilla PowerShell module scaffold</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="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none">
        <maml:name>DestinationPath</maml:name>
        <maml:Description>
          <maml:para>File path where PowerShell Module project will be created</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>Force</maml:name>
        <maml:Description>
          <maml:para>Skip Confirmation</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi">
        <maml:name>WhatIf</maml:name>
        <maml:Description>
          <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</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:parameter required="false" variableLength="true" 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>
        <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:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>System.Management.Automation.PSCustomObject</maml:name>
        </dev:type>
        <maml:description>
          <maml:para></maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <maml:alertSet>
      <maml:alert>
        <maml:para>General notes</maml:para>
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>
        <dev:code>New-PowerShellProject -CICDChoice 'AWS' -DestinationPath c:\path\AWSProject</dev:code>
        <dev:remarks>
          <maml:para>Scaffolds a PowerShell module project for integration with AWS CodeBuild.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title>
        <dev:code>New-PowerShellProject -CICDChoice 'GitHubActions' -DestinationPath c:\path\GitHubActions</dev:code>
        <dev:remarks>
          <maml:para>Scaffolds a PowerShell module project for integration with GitHub Actions Workflows.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title>
        <dev:code>New-PowerShellProject -CICDChoice 'Azure' -DestinationPath c:\path\AzurePipeline</dev:code>
        <dev:remarks>
          <maml:para>Scaffolds a PowerShell module project for integration with Azure DevOps Pipelines.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title>
        <dev:code>New-PowerShellProject -CICDChoice 'AppVeyor' -DestinationPath c:\path\AppVeyor</dev:code>
        <dev:remarks>
          <maml:para>Scaffolds a PowerShell module project for integration with AppVeyor Projects.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title>
        <dev:code>New-PowerShellProject -CICDChoice 'ModuleOnly' -DestinationPath c:\path\ModuleOnly</dev:code>
        <dev:remarks>
          <maml:para>Scaffolds a basic PowerShell module project with no additional extras. You just get a basic PowerShell module construct.</maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
    <command:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>https://docs.microsoft.com/powershell/scripting/developer/module/writing-a-windows-powershell-module</maml:linkText>
        <maml:uri>https://docs.microsoft.com/powershell/scripting/developer/module/writing-a-windows-powershell-module</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>https://aws.amazon.com/codebuild/</maml:linkText>
        <maml:uri>https://aws.amazon.com/codebuild/</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>https://help.github.com/actions</maml:linkText>
        <maml:uri>https://help.github.com/actions</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>https://azure.microsoft.com/services/devops/</maml:linkText>
        <maml:uri>https://azure.microsoft.com/services/devops/</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>https://www.appveyor.com/</maml:linkText>
        <maml:uri>https://www.appveyor.com/</maml:uri>
      </maml:navigationLink>
    </command:relatedLinks>
  </command:command>
</helpItems>