GitHubTeams: Add New/Update/Remove Functions #257

X-Guardian · 2020-06-29T17:12:15Z

Description

This PR adds the following functions to the GitHubTeams module:

Add-GitHubTeam
Update-GitHubTeam
Remove-GitHubTeam

It also adds the TeamName parameter to the Get-GitHubTeam function to allow getting team details by team name, which is used by the new functions.

Pester tests have also been added for the following functions:

Get-GitHubTeam
Add-GitHubTeam
Update-GitHubTeam
Remove-GitHubTeam

Positional Binding has been set as false for the three functions, and Position attributes added to the function's mandatory parameters.

Type view formats have been added for the GitHub.TeamSummary and GitHub.Team types.

Issues Fixed

None

References

GitHub Teams API

Checklist

You actually ran the code that you just wrote, especially if you did just "one last quick change".
Comment-based help added/updated, including examples.
Static analysis is reporting back clean.
New/changed code adheres to our coding guidelines.
Changes to the manifest file follow the manifest guidance.
Unit tests were added/updated and are all passing. See testing guidelines.
Relevant usage examples have been added/updated in USAGE.md.
~~If desired, ensure your name is added to our Contributors list~~

HowardWolosky

Some additional feedback for you to consider.

PowerShellForGitHub.psd1

Tests/GitHubTeams.tests.ps1

GitHubTeams.ps1

X-Guardian · 2020-07-18T11:55:40Z

I've re-added Set-StrictMode -Version 1.0 to the unit tests, as setting it in common.ps1 is out of scope for the tests and not working.

X-Guardian · 2020-07-18T11:55:55Z

@HowardWolosky, this PR is ready for the next review.

HowardWolosky · 2020-07-18T19:06:54Z

/azp run PowerShellForGitHub-CI

azure-pipelines · 2020-07-18T19:07:04Z

Azure Pipelines successfully started running 1 pipeline(s).

HowardWolosky · 2020-07-18T23:15:06Z

This had some test failures, likely do to timing issues. I see two options forward:

Easy option: Follow the pattern from Attempting to increase reliability of some Pester tests #265 and judiciously add some sleeps to help with the timing
Harder option: Try out Improve reliability (and speed) of UT's be transitioning to rely on a mock of Invoke-WebRequest #267 for most of your tests.

I recommend the first option for this PR.

X-Guardian · 2020-07-19T10:52:35Z

@HowardWolosky, I've added delays to the failing tests. Can you re-run the CI?

HowardWolosky · 2020-07-19T16:13:13Z

/azp run PowerShellForGitHub-CI

azure-pipelines · 2020-07-19T16:13:23Z

Azure Pipelines successfully started running 1 pipeline(s).

X-Guardian · 2020-07-21T16:51:39Z

@HowardWolosky, this PR is ready for the next review.

HowardWolosky · 2020-07-23T07:29:04Z

@X-Guardian - I have a backlog of work that I'm getting through, and so I haven't had the chance to re-review your updated PR's quite yet. I should get to your PR's by the end of the weekend. I appreciate your patience here.

HowardWolosky · 2020-07-31T20:43:06Z

/azp run PowerShellForGitHub-CI

azure-pipelines · 2020-07-31T20:43:19Z

Azure Pipelines successfully started running 1 pipeline(s).

X-Guardian · 2020-08-01T14:47:12Z

@HowardWolosky, can you run the CI for this PR?

HowardWolosky · 2020-08-03T16:57:59Z

/azp run PowerShellForGitHub-CI

azure-pipelines · 2020-08-03T16:58:20Z

Azure Pipelines successfully started running 1 pipeline(s).

X-Guardian · 2020-08-04T18:21:46Z

@HowardWolosky, can you run the CI for this PR?

HowardWolosky · 2020-08-04T18:23:07Z

/azp run PowerShellForGitHub-CI

azure-pipelines · 2020-08-04T18:23:18Z

Azure Pipelines successfully started running 1 pipeline(s).

X-Guardian · 2020-08-05T07:09:52Z

@HowardWolosky, can you run the CI for this PR?

HowardWolosky · 2020-08-05T15:01:28Z

/azp run PowerShellForGitHub-CI

azure-pipelines · 2020-08-05T15:01:42Z

Azure Pipelines successfully started running 1 pipeline(s).

HowardWolosky · 2020-08-09T21:30:29Z

/azp run PowerShellForGitHub-CI

azure-pipelines · 2020-08-09T21:30:40Z

Azure Pipelines successfully started running 1 pipeline(s).

…rdian/PowerShellForGitHub into GitHubTeams-Add-New-Remove

HowardWolosky · 2020-07-16T20:27:07Z

GitHubTeams.ps1

+            $repositoryFullName = @()
+            foreach ($repository in $RepositoryName)
+            {
+                $repositoryFullName += "$OrganizationName/$Repository"


Suggested change

$repositoryFullName += "$OrganizationName/$Repository"

$repositoryFullName += "$OrganizationName/$repository"

HowardWolosky · 2020-07-19T23:53:09Z

PowerShellForGitHub.psd1

@@ -1,240 +1,245 @@
-# Copyright (c) Microsoft Corporation. All rights reserved.


Can you update the line endings in this file so that we only see the actual diffs of the changes made?

It is because this file was originally saved as UTF-8 with BOM. Editing it within GitHub removes the BOM.

Tests/Common.ps1

Tests/GitHubTeams.tests.ps1

GitHubTeams.ps1

HowardWolosky · 2020-08-11T20:45:52Z

...and it's in! Thanks for your contribution here!

#257 did a fantastic job closing the gap on missing functionality in the module related to GitHub Teams. This PR just adds onto that work by providing options that will reduce the need for additional queries during common operations. * `Get-GitHubTeam`: **Breaking Change** Looking up a team by its `ID` has been deprecated per GitHub documentation. Removed that functionality and added the ability to look up by `slug` instead. This also means that you can now pipe in a team and get back the specific result without needing to filter through all org results. * `Get-GitHubTeamMember`: Updated to use the `slug` instead of the team `ID`. * `New-GitHubTeam`: Added ability to pass in the `ParentTeamId` (also via the pipeline) to avoid the need to query through all org teams. * `Set-GitHubTeam`: Added ability to pass in the team `slug` (also via the pipeline) to avoid the need to query through all org teams. Similar to `New-GitHubTeam`, also added the ability to pass-in the `ParentTeamId` to avoid the full org team lookup. * `Remove-GitHubTeam`: Added ability to pass in the team `slug` (also via the pipeline) to avoid the need to query through all org teams. * Added `Rename-GitHubTeam` as a helper/wrapper on top of `Set-GitHubTeam` * Added additional pipeline tests for existing functions * Added new tests for `Rename-GitHubTeam` and `Get-GitHubTeamMember` * Small update to formatters to simplify the display of the team parent References: [GitHub Teams API](https://developer.github.com/v3/teams/)

X-Guardian mentioned this pull request Jun 29, 2020

GitHubTeams: Add New/Update/Remove Functions #222

Closed

8 tasks

HowardWolosky added api completeness This is basic API functionality that hasn't been implemented yet. api-teams Work to complete the API's defined here: https://developer.github.com/v3/teams/ labels Jun 29, 2020

X-Guardian marked this pull request as ready for review July 6, 2020 17:28

HowardWolosky requested changes Jul 7, 2020

View reviewed changes

HowardWolosky added the waiting for update Waiting for an update to the PR before the next review label Jul 7, 2020

X-Guardian force-pushed the GitHubTeams-Add-New-Remove branch from d50b6e3 to a128b92 Compare July 21, 2020 16:49

X-Guardian force-pushed the GitHubTeams-Add-New-Remove branch from 5b5c1a0 to 34a1abf Compare August 1, 2020 14:38

X-Guardian added 7 commits August 4, 2020 19:17

GithubTeams: Add New/Remove/Update

ffb7897

Update USAGE.md

2792007

Update SuppressMessageAttributes

2e51de1

Add conditional parms to Get-GitHubTeam calls

fd64dfd

Add Remove-GitHubTeams -Force switch

e96f3e9

Fix formatting

8b4dd87

Remove redundant Invocation parameters

564bef4

X-Guardian added 8 commits August 4, 2020 19:17

Update psd1

40b6a71

Fix review comments

154dd0d

Add Team formatters

54434e0

Fix review comments

10171f6

Add delays to failing tests

e5f8ecc

Update tests

02db166

Restore StateChangeDelaySeconds to 3

9d8d8fa

Standardise ShouldProcess

1185492

X-Guardian force-pushed the GitHubTeams-Add-New-Remove branch from f262b52 to 1185492 Compare August 4, 2020 18:21

Remove unneeded Whatif/Confirm parms

92d2425

Merge branch 'master' into GitHubTeams-Add-New-Remove

c4bfed2

X-Guardian and others added 3 commits August 11, 2020 07:44

Merge branch 'master' into GitHubTeams-Add-New-Remove

5b09795

Fix Remove-GitHubTeam test

4275e71

Merge branch 'GitHubTeams-Add-New-Remove' of https://github.com/X-Gua…

54ad491

…rdian/PowerShellForGitHub into GitHubTeams-Add-New-Remove

HowardWolosky requested changes Aug 11, 2020

View reviewed changes

Fix review comments

96f056e

HowardWolosky approved these changes Aug 11, 2020

View reviewed changes

HowardWolosky merged commit 6a51601 into microsoft:master Aug 11, 2020

X-Guardian deleted the GitHubTeams-Add-New-Remove branch August 12, 2020 06:34

HowardWolosky mentioned this pull request Aug 12, 2020

Improvements to GitHub Team API's #275

Merged

10 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GitHubTeams: Add New/Update/Remove Functions #257

GitHubTeams: Add New/Update/Remove Functions #257

X-Guardian commented Jun 29, 2020 •

edited

HowardWolosky left a comment

X-Guardian commented Jul 18, 2020

X-Guardian commented Jul 18, 2020

HowardWolosky commented Jul 18, 2020

azure-pipelines bot commented Jul 18, 2020

HowardWolosky commented Jul 18, 2020

X-Guardian commented Jul 19, 2020

HowardWolosky commented Jul 19, 2020

azure-pipelines bot commented Jul 19, 2020

X-Guardian commented Jul 21, 2020

HowardWolosky commented Jul 23, 2020

HowardWolosky commented Jul 31, 2020

azure-pipelines bot commented Jul 31, 2020

X-Guardian commented Aug 1, 2020

HowardWolosky commented Aug 3, 2020

azure-pipelines bot commented Aug 3, 2020

X-Guardian commented Aug 4, 2020

HowardWolosky commented Aug 4, 2020

azure-pipelines bot commented Aug 4, 2020

X-Guardian commented Aug 5, 2020

HowardWolosky commented Aug 5, 2020

azure-pipelines bot commented Aug 5, 2020

HowardWolosky commented Aug 9, 2020

azure-pipelines bot commented Aug 9, 2020

HowardWolosky Jul 16, 2020

HowardWolosky Jul 19, 2020

X-Guardian Aug 11, 2020

HowardWolosky commented Aug 11, 2020

	$repositoryFullName += "$OrganizationName/$Repository"
	$repositoryFullName += "$OrganizationName/$repository"

		@@ -1,240 +1,245 @@
		# Copyright (c) Microsoft Corporation. All rights reserved.

GitHubTeams: Add New/Update/Remove Functions #257

GitHubTeams: Add New/Update/Remove Functions #257

Conversation

X-Guardian commented Jun 29, 2020 • edited

Description

Issues Fixed

References

Checklist

HowardWolosky left a comment

Choose a reason for hiding this comment

X-Guardian commented Jul 18, 2020

X-Guardian commented Jul 18, 2020

HowardWolosky commented Jul 18, 2020

azure-pipelines bot commented Jul 18, 2020

HowardWolosky commented Jul 18, 2020

X-Guardian commented Jul 19, 2020

HowardWolosky commented Jul 19, 2020

azure-pipelines bot commented Jul 19, 2020

X-Guardian commented Jul 21, 2020

HowardWolosky commented Jul 23, 2020

HowardWolosky commented Jul 31, 2020

azure-pipelines bot commented Jul 31, 2020

X-Guardian commented Aug 1, 2020

HowardWolosky commented Aug 3, 2020

azure-pipelines bot commented Aug 3, 2020

X-Guardian commented Aug 4, 2020

HowardWolosky commented Aug 4, 2020

azure-pipelines bot commented Aug 4, 2020

X-Guardian commented Aug 5, 2020

HowardWolosky commented Aug 5, 2020

azure-pipelines bot commented Aug 5, 2020

HowardWolosky commented Aug 9, 2020

azure-pipelines bot commented Aug 9, 2020

HowardWolosky Jul 16, 2020

Choose a reason for hiding this comment

HowardWolosky Jul 19, 2020

Choose a reason for hiding this comment

X-Guardian Aug 11, 2020

Choose a reason for hiding this comment

HowardWolosky commented Aug 11, 2020

X-Guardian commented Jun 29, 2020 •

edited