Skip to content

Commit 3d90cb5

Browse files
🪲 [Fix]: Issue where Remove-GitHubTeam was not exported (#164)
## Description - Rename `Delete-GitHubTeam` file to `Remove-GitHubTeam` so that it gets exported. - Added examples demonstrating how to use - `New-GitHubTeam` - `Update-GitHubTeam` - `Remove-GitHubTeam` ## Type of change <!-- Use the check-boxes [x] on the options that are relevant. --> - [ ] 📖 [Docs] - [x] 🪲 [Fix] - [ ] 🩹 [Patch] - [ ] ⚠️ [Security fix] - [ ] 🚀 [Feature] - [ ] 🌟 [Breaking change] ## Checklist <!-- Use the check-boxes [x] on the options that are relevant. --> - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas
1 parent 034f03c commit 3d90cb5

File tree

3 files changed

+24
-2
lines changed

3 files changed

+24
-2
lines changed

src/functions/public/Teams/New-GitHubTeam.ps1

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,18 @@
1212
`maintainers`. For more information, see
1313
"[About teams](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/about-teams)".
1414
15+
.EXAMPLE
16+
$params = @{
17+
Organization = 'github'
18+
Name = 'team-name'
19+
Description = 'A new team'
20+
Maintainers = 'octocat'
21+
RepoNames = 'github/octocat'
22+
Privacy = 'closed'
23+
Permission = 'pull'
24+
}
25+
New-GitHubTeam @params
26+
1527
.NOTES
1628
[Create a team](https://docs.github.com/rest/teams/teams#create-a-team)
1729
#>

src/functions/public/Teams/Delete-GitHubTeam.ps1 renamed to src/functions/public/Teams/Remove-GitHubTeam.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
If you are an organization owner, deleting a parent team will delete all of its child teams as well.
99
1010
.EXAMPLE
11-
An example
11+
Remove-GitHubTeam -Organization 'github' -Name 'team-name'
1212
1313
.NOTES
1414
[Delete a team](https://docs.github.com/en/rest/teams/teams?apiVersion=2022-11-28#delete-a-team)

src/functions/public/Teams/Update-GitHubTeam.ps1

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,17 @@
77
To edit a team, the authenticated user must either be an organization owner or a team maintainer.
88
99
.EXAMPLE
10-
10+
$params = @{
11+
Organization = 'github'
12+
Name = 'team-name'
13+
NewName = 'new-team-name'
14+
Description = 'A new team'
15+
Privacy = 'closed'
16+
NotificationSetting = 'notifications_enabled'
17+
Permission = 'pull'
18+
ParentTeamID = 123456
19+
}
20+
Update-GitHubTeam @params
1121
1222
.NOTES
1323
[Update a team](https://docs.github.com/en/rest/teams/teams?apiVersion=2022-11-28#update-a-team)

0 commit comments

Comments
 (0)