forked from ModuleBuild/ModuleBuild
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathplasterManifest.xml
More file actions
261 lines (261 loc) · 9.48 KB
/
Copy pathplasterManifest.xml
File metadata and controls
261 lines (261 loc) · 9.48 KB
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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
<?xml version="1.0" encoding="utf-8"?>
<plasterManifest
schemaVersion="1.1"
templateType="Project" xmlns="http://www.microsoft.com/schemas/PowerShell/Plaster/v1">
<metadata>
<name>ModuleBuild</name>
<id>c0ce518c-f894-4114-91f9-d49945d9dfb1</id>
<version>0.0.1</version>
<title>New ModuleBuild Project</title>
<description>Create a new PowerShell Module with a ModuleBuild wrapper</description>
<author>Zachary Loeber</author>
<tags>Module, ModuleManifest, ModuleBuild</tags>
</metadata>
<parameters>
<parameter
name="ModuleName"
type="text"
prompt="Enter the name of the module. No space, underscores, or special characters are allowed" />
<parameter
name="ModuleDescription"
type="text"
prompt="Enter a description of your module" />
<parameter
name="ModuleAuthor"
type="text"
prompt="Enter a module author" />
<parameter
name="ModuleWebsite"
type="text"
prompt="Enter a project website (ie. https://www.github.com/<author>/<modulename>)" />
<parameter
name="ModuleVersion"
type="text"
prompt="Enter the version number of the module"
default="0.0.1" />
<parameter
name="ModuleTags"
type="text"
prompt="Comma separate list of tags that describe this module. This is required for the PowerShell Gallery" />
<parameter
name="ProjectLicense"
type="choice"
prompt="What license would you like for this module to have?"
default="0">
<choice
label="&Creative Commons"
help="This license lets others distribute, remix, tweak, and build upon your work, even commercially, as long as they credit you for the original creation."
value="CreativeCommons" />
<choice
label="&MIT"
help="A short, permissive software license. Basically, you can do whatever you want as long as you include the original copyright and license notice in any copy of the software/source."
value="MIT" />
<choice
label="&Apache 2.0"
help="You can do what you like with the software, as long as you include the required notices. This permissive license contains a patent license from the contributors of the code."
value="Apache" />
<choice
label="&GPL 3.0"
help="You may copy, distribute and modify the software as long as you track changes/dates in source files. Any modifications to or software including (via compiler) GPL-licensed code must also be made available under the GPL along with build & install instructions."
value="GPL" />
</parameter>
<parameter
name="OptionAnalyzeCode"
type="choice"
prompt="Use PSScriptAnalyzer in the module build process (Recommended for Gallery uploading)?"
default="0">
<choice
label="&Yes"
help="Enable script analysis"
value="True" />
<choice
label="&No"
help="Disable script analysis"
value="False" />
</parameter>
<parameter
name="OptionCodeHealthReport"
type="choice"
prompt="Use PSCodeHealth to generate public and private function code health reports. (This can slow down the build process.)"
default="0">
<choice
label="&Yes"
help="Enable code health reporting"
value="True" />
<choice
label="&No"
help="Disable code health reporting"
value="False" />
</parameter>
<parameter
name="OptionUpdateVersionAfterPublishing"
type="choice"
prompt="Automatically increase the module patch version after publishing to the gallary?"
default="0">
<choice
label="&Yes"
help="Increase the patch version after a successful publish to the gallery"
value="True" />
<choice
label="&No"
help="Do not increase the patch version after a successful gallery publish"
value="False" />
</parameter>
<parameter
name="OptionSanitizeSensitiveTerms"
type="choice"
prompt="Scan for sensitive terms (like your user id or company domain) in the module build process (Recommended for Gallery uploading)?"
default="1">
<choice
label="&Yes"
help="Sanitize sensitive terms"
value="True" />
<choice
label="&No"
help="Do not sanitize sensitive terms"
value="False" />
</parameter>
<parameter
name="OptionGenerateReadTheDocs"
type="choice"
prompt="Generate YML file in build process for ReadTheDocs.org integration?"
default="1">
<choice
label="&Yes"
help="The YML file will get regenerated at every build. This file gets saved in the root folder of your project."
value="True" />
<choice
label="&No"
help="No YML file will be generated."
value="False" />
</parameter>
<parameter
name="PluginModuleLogging"
type="choice"
prompt="Plugin - Include NLog logging capabilities in the module?"
default="1">
<choice
label="&Yes"
help="The project will include nlog binaries and transparent logging capabilities."
value="True" />
<choice
label="&No"
help="The project will NOT include nlog binaries and transparent logging capabilities."
value="False" />
</parameter>
</parameters>
<content>
<newModuleManifest
description="${PLASTER_PARAM_ModuleDescription}"
copyright="(c) ${PLASTER_Year} ${PLASTER_PARAM_ModuleAuthor}. All rights reserved."
tags="${PLASTER_PARAM_ModuleTags}"
companyName="${PLASTER_PARAM_ModuleAuthor}"
author="${PLASTER_PARAM_ModuleAuthor}"
licenseUri="${PLASTER_PARAM_ModuleWebsite}/raw/master/LICENSE.md"
projectUri="${PLASTER_PARAM_ModuleWebsite}"
rootModule="${PLASTER_PARAM_ModuleName}.psm1"
variablesToExport=""
aliasesToExport=""
iconUri="${PLASTER_PARAM_ModuleWebsite}/raw/master/src/other/powershell-project.png"
functionsToExport="*"
moduleVersion="${PLASTER_PARAM_ModuleVersion}"
encoding="UTF8-NoBOM"
destination="${PLASTER_PARAM_ModuleName}.psd1" />
<templateFile
source="scaffold\gitignore"
destination=".gitignore" />
<file
source="scaffold\gitattributes"
destination=".gitattributes" />
<templateFile
source="scaffold\vscode\*"
destination=".vscode" />
<templateFile
source="scaffold\github\*"
destination=".github" />
<file
source="scaffold\src\other\*"
destination="src\other" />
<file
source="scaffold\src\private\*"
destination="src\private" />
<file
source="scaffold\src\public\*"
destination="src\public" />
<file
source="scaffold\src\templates\*"
destination="src\templates" />
<file
source="scaffold\tests\*"
destination="src\tests" />
<templateFile
source="scaffold\plugins\NLog\*"
destination="plugins\nlog"
condition="$PLASTER_PARAM_PluginModuleLogging -eq "True"" />
<file
source="scaffold\plugins\NLog\NLogModule\*"
destination="plugins\nlog\NLog\NLogModule"
condition="$PLASTER_PARAM_PluginModuleLogging -eq "True"" />
<file
source="scaffold\build\cleanup\*"
destination="build\cleanup" />
<file
source="scaffold\build\startup\*"
destination="build\startup" />
<file
source="scaffold\build\dotsource\*"
destination="build\dotsource" />
<file
source="scaffold\build\tools\*"
destination="build\tools" />
<templateFile
source="scaffold\licenses\CreativeCommons.md"
destination="LICENSE.md"
condition="$PLASTER_PARAM_ProjectLicense -eq "CreativeCommons"" />
<templateFile
source="scaffold\licenses\MIT.md"
destination="LICENSE.md"
condition="$PLASTER_PARAM_ProjectLicense -eq "MIT"" />
<templateFile
source="scaffold\licenses\Apache.md"
destination="LICENSE.md"
condition="$PLASTER_PARAM_ProjectLicense -eq "Apache"" />
<templateFile
source="scaffold\licenses\GPL.md"
destination="LICENSE.md"
condition="$PLASTER_PARAM_ProjectLicense -eq "GPL"" />
<templateFile
source="scaffold\ModuleName.template"
destination="${PLASTER_PARAM_ModuleName}.psm1" />
<templateFile
source="scaffold\modulename.build.template"
destination="${PLASTER_PARAM_ModuleName}.build.ps1" />
<templateFile
source="scaffold\build\modulename.buildenvironment.template"
destination="build\${PLASTER_PARAM_ModuleName}.buildenvironment.ps1" />
<templateFile
source="scaffold\readme.md"
destination="Readme.md" />
<templateFile
source="scaffold\Build.template"
destination="Build.ps1" />
<templateFile
source="scaffold\Install.template"
destination="Install.ps1" />
<templateFile
source="scaffold\build\docs\*"
destination="build\docs" />
<templateFile
source="scaffold\build\docs\en-US\about_ModuleName.help.txt"
destination="build\docs\en-US\about_${PLASTER_PARAM_ModuleName}.help.txt" />
<templateFile
source="scaffold\build\docs\Additional\*"
destination="build\docs\Additional" />
<templateFile
source="scaffold\build\docs\Additional\*"
destination="docs" />
<templateFile
source="scaffold\build\docs\ReadTheDocs\*"
destination="build\docs\ReadTheDocs" />
</content>
</plasterManifest>