Skip to content

Commit 985044f

Browse files
chris-petersonchris-peterson
committed
Generate help file templates using PlatyPS
1 parent 7cf0cea commit 985044f

200 files changed

Lines changed: 37190 additions & 333 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/ci.yml‎

Lines changed: 54 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,6 @@ jobs:
6767

6868
security:
6969
name: Run Security Analysis
70-
needs: test
7170
runs-on: ubuntu-latest
7271

7372
steps:
@@ -123,9 +122,52 @@ jobs:
123122
name: security-results
124123
path: SecurityResults.json
125124

125+
docs:
126+
name: Validate Documentation
127+
runs-on: ubuntu-latest
128+
129+
steps:
130+
- uses: actions/checkout@v6
131+
132+
- name: Install Modules
133+
shell: pwsh
134+
run: |
135+
Set-PSRepository PSGallery -InstallationPolicy Trusted
136+
Install-Module -Name Microsoft.PowerShell.PlatyPS -Force -Scope CurrentUser
137+
Install-Module -Name powershell-yaml -Force -Scope CurrentUser
138+
139+
- name: Check help is up to date
140+
shell: pwsh
141+
run: |
142+
$ErrorActionPreference = 'Continue'
143+
try {
144+
./help/Update-Help.ps1 -ThrowOnChanges
145+
$CmdletCount = (Get-ChildItem -Path ./docs -Filter *.md -Recurse).Count
146+
$Summary = "## Documentation Validation`n`n"
147+
$Summary += "**$CmdletCount cmdlets** up-to-date`n"
148+
$Summary | Out-File -FilePath $env:GITHUB_STEP_SUMMARY -Append
149+
}
150+
catch {
151+
# Get the list of changed files
152+
$ModifiedFiles = git diff --name-only -- docs/
153+
$UntrackedFiles = git ls-files --others --exclude-standard -- docs/
154+
$PendingChanges = @($ModifiedFiles) + @($UntrackedFiles) | Where-Object { $_ }
155+
156+
$Summary = "## Documentation Validation`n`n"
157+
$Summary += "❌ Markdown help is out of sync.`n`n"
158+
$Summary += "### Files needing update:`n`n"
159+
foreach ($file in $PendingChanges) {
160+
$Summary += "- ``$file```n"
161+
}
162+
$Summary += "`nRun ``help/Update-Help.ps1`` locally and commit the changes.`n"
163+
$Summary | Out-File -FilePath $env:GITHUB_STEP_SUMMARY -Append
164+
165+
throw $_.Exception.Message
166+
}
167+
126168
release-gate:
127169
name: Release Gate
128-
needs: [test, security]
170+
needs: [test, security, docs]
129171
if: github.event.repository.fork == false && github.ref_name == 'main'
130172
runs-on: ubuntu-latest
131173
steps:
@@ -142,6 +184,16 @@ jobs:
142184
steps:
143185
- uses: actions/checkout@v6
144186

187+
- name: Install PlatyPS
188+
shell: pwsh
189+
run: |
190+
Set-PSRepository PSGallery -InstallationPolicy Trusted
191+
Install-Module -Name Microsoft.PowerShell.PlatyPS -Force -Scope CurrentUser
192+
193+
- name: Export MAML help
194+
shell: pwsh
195+
run: ./help/Export-Help.ps1
196+
145197
- name: Publish PowerShell Module
146198
uses: chris-peterson/publish-powershell-modules@v1
147199
with:

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@ test.ps1
33
.DS_Store
44
*.csv
55
PLANNING.md
6+
src/GitlabCli/en-US

‎docs/AuditEvents/Get-GitlabAuditEvent.md‎

Lines changed: 301 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,301 @@
1+
---
2+
document type: cmdlet
3+
external help file: GitlabCli-Help.xml
4+
HelpUri: https://github.com/chris-peterson/pwsh-gitlab/blob/main/docs/AuditEvents/Get-GitlabAuditEvent.md
5+
Locale: en-US
6+
Module Name: GitlabCli
7+
ms.date: 12/27/2025
8+
PlatyPS schema version: 2024-05-01
9+
title: Get-GitlabAuditEvent
10+
---
11+
12+
# Get-GitlabAuditEvent
13+
14+
## SYNOPSIS
15+
16+
{{ Fill in the Synopsis }}
17+
18+
## SYNTAX
19+
20+
### __AllParameterSets
21+
22+
```
23+
Get-GitlabAuditEvent [[-ProjectId] <string>] [[-GroupId] <string>] [[-AuditEventId] <string>]
24+
[[-EntityType] <string>] [[-EntityId] <string>] [[-MaxPages] <uint>] [[-Before] <string>]
25+
[[-After] <string>] [[-SiteUrl] <string>] [-FetchAuthors] [-All] [<CommonParameters>]
26+
```
27+
28+
## ALIASES
29+
30+
## DESCRIPTION
31+
32+
{{ Fill in the Description }}
33+
34+
## EXAMPLES
35+
36+
### Example 1
37+
38+
{{ Add example description here }}
39+
40+
## PARAMETERS
41+
42+
### -After
43+
44+
{{ Fill After Description }}
45+
46+
```yaml
47+
Type: System.String
48+
DefaultValue: ''
49+
SupportsWildcards: false
50+
Aliases:
51+
- Since
52+
ParameterSets:
53+
- Name: (All)
54+
Position: 7
55+
IsRequired: false
56+
ValueFromPipeline: false
57+
ValueFromPipelineByPropertyName: false
58+
ValueFromRemainingArguments: false
59+
DontShow: false
60+
AcceptedValues: []
61+
HelpMessage: ''
62+
```
63+
64+
### -All
65+
66+
{{ Fill All Description }}
67+
68+
```yaml
69+
Type: System.Management.Automation.SwitchParameter
70+
DefaultValue: ''
71+
SupportsWildcards: false
72+
Aliases: []
73+
ParameterSets:
74+
- Name: (All)
75+
Position: Named
76+
IsRequired: false
77+
ValueFromPipeline: false
78+
ValueFromPipelineByPropertyName: false
79+
ValueFromRemainingArguments: false
80+
DontShow: false
81+
AcceptedValues: []
82+
HelpMessage: ''
83+
```
84+
85+
### -AuditEventId
86+
87+
{{ Fill AuditEventId Description }}
88+
89+
```yaml
90+
Type: System.String
91+
DefaultValue: ''
92+
SupportsWildcards: false
93+
Aliases: []
94+
ParameterSets:
95+
- Name: (All)
96+
Position: 2
97+
IsRequired: false
98+
ValueFromPipeline: false
99+
ValueFromPipelineByPropertyName: false
100+
ValueFromRemainingArguments: false
101+
DontShow: false
102+
AcceptedValues: []
103+
HelpMessage: ''
104+
```
105+
106+
### -Before
107+
108+
{{ Fill Before Description }}
109+
110+
```yaml
111+
Type: System.String
112+
DefaultValue: ''
113+
SupportsWildcards: false
114+
Aliases:
115+
- Until
116+
ParameterSets:
117+
- Name: (All)
118+
Position: 6
119+
IsRequired: false
120+
ValueFromPipeline: false
121+
ValueFromPipelineByPropertyName: false
122+
ValueFromRemainingArguments: false
123+
DontShow: false
124+
AcceptedValues: []
125+
HelpMessage: ''
126+
```
127+
128+
### -EntityId
129+
130+
{{ Fill EntityId Description }}
131+
132+
```yaml
133+
Type: System.String
134+
DefaultValue: ''
135+
SupportsWildcards: false
136+
Aliases: []
137+
ParameterSets:
138+
- Name: (All)
139+
Position: 4
140+
IsRequired: false
141+
ValueFromPipeline: false
142+
ValueFromPipelineByPropertyName: false
143+
ValueFromRemainingArguments: false
144+
DontShow: false
145+
AcceptedValues: []
146+
HelpMessage: ''
147+
```
148+
149+
### -EntityType
150+
151+
{{ Fill EntityType Description }}
152+
153+
```yaml
154+
Type: System.String
155+
DefaultValue: ''
156+
SupportsWildcards: false
157+
Aliases: []
158+
ParameterSets:
159+
- Name: (All)
160+
Position: 3
161+
IsRequired: false
162+
ValueFromPipeline: false
163+
ValueFromPipelineByPropertyName: false
164+
ValueFromRemainingArguments: false
165+
DontShow: false
166+
AcceptedValues: []
167+
HelpMessage: ''
168+
```
169+
170+
### -FetchAuthors
171+
172+
{{ Fill FetchAuthors Description }}
173+
174+
```yaml
175+
Type: System.Management.Automation.SwitchParameter
176+
DefaultValue: ''
177+
SupportsWildcards: false
178+
Aliases: []
179+
ParameterSets:
180+
- Name: (All)
181+
Position: Named
182+
IsRequired: false
183+
ValueFromPipeline: false
184+
ValueFromPipelineByPropertyName: false
185+
ValueFromRemainingArguments: false
186+
DontShow: false
187+
AcceptedValues: []
188+
HelpMessage: ''
189+
```
190+
191+
### -GroupId
192+
193+
{{ Fill GroupId Description }}
194+
195+
```yaml
196+
Type: System.String
197+
DefaultValue: ''
198+
SupportsWildcards: false
199+
Aliases: []
200+
ParameterSets:
201+
- Name: (All)
202+
Position: 1
203+
IsRequired: false
204+
ValueFromPipeline: false
205+
ValueFromPipelineByPropertyName: true
206+
ValueFromRemainingArguments: false
207+
DontShow: false
208+
AcceptedValues: []
209+
HelpMessage: ''
210+
```
211+
212+
### -MaxPages
213+
214+
{{ Fill MaxPages Description }}
215+
216+
```yaml
217+
Type: System.UInt32
218+
DefaultValue: ''
219+
SupportsWildcards: false
220+
Aliases: []
221+
ParameterSets:
222+
- Name: (All)
223+
Position: 5
224+
IsRequired: false
225+
ValueFromPipeline: false
226+
ValueFromPipelineByPropertyName: false
227+
ValueFromRemainingArguments: false
228+
DontShow: false
229+
AcceptedValues: []
230+
HelpMessage: ''
231+
```
232+
233+
### -ProjectId
234+
235+
{{ Fill ProjectId Description }}
236+
237+
```yaml
238+
Type: System.String
239+
DefaultValue: ''
240+
SupportsWildcards: false
241+
Aliases: []
242+
ParameterSets:
243+
- Name: (All)
244+
Position: 0
245+
IsRequired: false
246+
ValueFromPipeline: false
247+
ValueFromPipelineByPropertyName: true
248+
ValueFromRemainingArguments: false
249+
DontShow: false
250+
AcceptedValues: []
251+
HelpMessage: ''
252+
```
253+
254+
### -SiteUrl
255+
256+
{{ Fill SiteUrl Description }}
257+
258+
```yaml
259+
Type: System.String
260+
DefaultValue: ''
261+
SupportsWildcards: false
262+
Aliases: []
263+
ParameterSets:
264+
- Name: (All)
265+
Position: 8
266+
IsRequired: false
267+
ValueFromPipeline: false
268+
ValueFromPipelineByPropertyName: false
269+
ValueFromRemainingArguments: false
270+
DontShow: false
271+
AcceptedValues: []
272+
HelpMessage: ''
273+
```
274+
275+
### CommonParameters
276+
277+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
278+
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
279+
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
280+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
281+
282+
## INPUTS
283+
284+
### System.String
285+
286+
{{ Fill in the Description }}
287+
288+
## OUTPUTS
289+
290+
### System.Object
291+
292+
{{ Fill in the Description }}
293+
294+
## NOTES
295+
296+
{{ Fill in the Notes }}
297+
298+
## RELATED LINKS
299+
300+
{{ Fill in the related links here }}
301+

0 commit comments

Comments
 (0)