Add parent_team_id, maintainers and notification_setting for creating and updating teams. #2863

Cheshirez · 2023-12-14T02:16:23Z

All prerequisites been done in lib, so this commit just extends create_team and update_team methods with optional parameter parent_team_id as per GH documentation:

Updated validation data to pass tests and also had tested all create/update/absent parent_id cases on real environment.

codecov-commenter · 2023-12-14T02:18:16Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (cc4c526) 96.70% compared to head (effb4ca) 96.70%.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2863   +/-   ##
=======================================
  Coverage   96.70%   96.70%           
=======================================
  Files         147      147           
  Lines       14873    14885   +12     
=======================================
+ Hits        14383    14395   +12     
  Misses        490      490

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Cheshirez · 2023-12-18T18:14:34Z

@EnricoMi could you please take a look on this PR?

Signed-off-by: Andrii Kezikov <cheshirez@gmail.com>

EnricoMi

While you are there, can you add the other missing arguments as well?

maintainers
notification_setting

Signed-off-by: Andrii Kezikov <cheshirez@gmail.com>

Cheshirez · 2023-12-20T03:26:15Z

Added maintainers to the create_team method (it don't appear in other requests and returns).
@EnricoMi can we add notification_setting in separate PR?
That's require to add a property, which has default so we'll need to update a lot ReplayData for that.

EnricoMi · 2023-12-20T06:45:07Z

That's require to add a property, which has default so we'll need to update a lot ReplayData for that.

The method signature can have notification_setting: Opt[str] = NotSet as Github applies the default. This would not change recorded data.

Having notification_setting: Opt[str] = "notifications_enabled" would be preferable. I think this would only add notification_setting to the POST payload, but the response should stay unchanged, so this could be added manually without recording new data.

Signed-off-by: Andrii Kezikov <cheshirez@gmail.com>

Cheshirez · 2023-12-22T23:26:19Z

Added notification_setting param.

github/Organization.py

github/Team.py

tests/ReplayData/Team.testEditWithAllArguments.txt

tests/ReplayData/Organization.testCreateTeamWithAllArguments.txt

tests/Organization.py

tests/Team.py

Signed-off-by: Andrii Kezikov <cheshirez@gmail.com>

Cheshirez · 2024-01-26T20:00:19Z

Added notification_settings to tests assertion as well. @EnricoMi could you please review?
Sorry for the delay.

EnricoMi

LGTM! Two minor changes requested.

github/Organization.py

github/Team.py

EnricoMi

LGTM!

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [PyGithub](https://togithub.com/pygithub/pygithub) | `==2.1.1` -> `==2.2.0` | [![age](https://developer.mend.io/api/mc/badges/age/pypi/PyGithub/2.2.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/pypi/PyGithub/2.2.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/pypi/PyGithub/2.1.1/2.2.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/PyGithub/2.1.1/2.2.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>pygithub/pygithub (PyGithub)</summary> ### [`v2.2.0`](https://togithub.com/PyGithub/PyGithub/releases/tag/v2.2.0) [Compare Source](https://togithub.com/pygithub/pygithub/compare/v2.1.1...v2.2.0) #### Breaking Changes The `github.Comparison.Comparison` instance returned by `Repository.compare` provides a `commits` property that used to return a `list[github.Commit.Commit]`, which has now been changed to `PaginatedList[github.Commit.Commit]`. This breaks user code that assumes a `list`: ```python commits = repo.compare("v0.6", "v0.7").commits no_of_commits = len(commits) # will raise a TypeError ``` This will raise a `TypeError: object of type 'PaginatedList' has no len()`, as the returned `PaginatedList` does not support the `len()` method. Use the `totalCount` property instead: ```python commits = repo.compare("v0.6", "v0.7").commits no_of_commits = commits.totalCount ``` #### New features - Add support to call GraphQL API #### Improvements - Add parent_team_id, maintainers and notification_setting for creating and updating teams. by [@Cheshirez](https://togithub.com/Cheshirez) in [PyGithub/PyGithub#2863 - Add support for issue reactions summary by [@smuzaffar](https://togithub.com/smuzaffar) in [PyGithub/PyGithub#2866 - Support for DependabotAlert APIs by [@coopernetes](https://togithub.com/coopernetes) in [PyGithub/PyGithub#2879 - Derive GraphQL URL from base_url by [@EnricoMi](https://togithub.com/EnricoMi) in [PyGithub/PyGithub#2880 - Make `Repository.compare().commits` return paginated list by [@EnricoMi](https://togithub.com/EnricoMi) in [PyGithub/PyGithub#2882 - Add missing branch protection fields by [@treee111](https://togithub.com/treee111) in [PyGithub/PyGithub#2873 - Add `include_all_branches` to `create_repo_from_template` of `AuthenticatedUser` and `Organization` by [@janssonoskar](https://togithub.com/janssonoskar) in [PyGithub/PyGithub#2871 - Add and update organisation dependabot secrets by [@mohy01](https://togithub.com/mohy01) in [PyGithub/PyGithub#2316 - Add missing params to `Organization.create_repo` by [@tekumara](https://togithub.com/tekumara) in [PyGithub/PyGithub#2700 - Update allowed values for `Repository` collaborator permissions by [@flying-sheep](https://togithub.com/flying-sheep) in [PyGithub/PyGithub#1996 - Support editing PullRequestReview by [@ColasGael](https://togithub.com/ColasGael) in [PyGithub/PyGithub#2851 - Update attributes after calling `PullRequestReview.dismiss` by [@ColasGael](https://togithub.com/ColasGael) in [PyGithub/PyGithub#2854 - Add `request_cve` on `RepositoryAdvisories` by [@JLLeitschuh](https://togithub.com/JLLeitschuh) in [PyGithub/PyGithub#2855 - Filter collaborators of a repository by permissions by [@notmicaelfilipe](https://togithub.com/notmicaelfilipe) in [PyGithub/PyGithub#2792 - Set pull request to auto merge via GraphQL API by [@heitorpolidoro](https://togithub.com/heitorpolidoro) in [PyGithub/PyGithub#2816 - Support Environment Variables and Secrets by [@AndrewJDawes](https://togithub.com/AndrewJDawes) in [PyGithub/PyGithub#2848 - Update workflow.get_runs & pullrequest.add_to_assignees function signature by [@sd-kialo](https://togithub.com/sd-kialo) in [PyGithub/PyGithub#2799 - Add `GithubObject.last_modified_datetime` to have `last_modified` as a `datetime` by [@chouetz](https://togithub.com/chouetz) in [PyGithub/PyGithub#2772 - Add support for global advisories and unify some shared logic with repository advisories by [@crimsonknave](https://togithub.com/crimsonknave) in [PyGithub/PyGithub#2702 - Add `internal` as valid Repository visibility value by [@AndrewJDawes](https://togithub.com/AndrewJDawes) in [PyGithub/PyGithub#2806 - Add support for issue comments reactions summary by [@smuzaffar](https://togithub.com/smuzaffar) in [PyGithub/PyGithub#2813 #### Bug Fixes - Add a bunch of missing urllib.parse.quote calls by [@ExplodingCabbage](https://togithub.com/ExplodingCabbage) in [PyGithub/PyGithub#1976 - Fix Variable and Secret url bugs by [@AndrewJDawes](https://togithub.com/AndrewJDawes) in [PyGithub/PyGithub#2835 #### Maintenance - Update the class name for NetrcAuth in the examples by [@vinnybod](https://togithub.com/vinnybod) in [PyGithub/PyGithub#2860 - Move build to PEP517 by [@trim21](https://togithub.com/trim21) in [PyGithub/PyGithub#2800 - Use new type assert functions in `Repository` by [@trim21](https://togithub.com/trim21) in [PyGithub/PyGithub#2798 - PyTest: Move config to pyproject.toml by [@Borda](https://togithub.com/Borda) in [PyGithub/PyGithub#2859 - codespell: ignore-words-list by [@Borda](https://togithub.com/Borda) in [PyGithub/PyGithub#2858 - Improve fix-headers.py script by [@EnricoMi](https://togithub.com/EnricoMi) in [PyGithub/PyGithub#2728 - Remove dependency on python-dateutil by [@lazka](https://togithub.com/lazka) in [PyGithub/PyGithub#2804 - CI: update precommit & apply by [@Borda](https://togithub.com/Borda) in [PyGithub/PyGithub#2600 - Docs: Fix parameter order according to Version 2.1.0 by [@nad182](https://togithub.com/nad182) in [PyGithub/PyGithub#2786 - Add missing GitHub classes to docs by [@EnricoMi](https://togithub.com/EnricoMi) in [PyGithub/PyGithub#2783 - CI: Fix mypy error by ignoring override by [@EnricoMi](https://togithub.com/EnricoMi) in [PyGithub/PyGithub#2779 **Full Changelog**: PyGithub/PyGithub@v2.1.1...v2.2.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/lettuce-financial/github-bot-signed-commit).

Set missing parent_team_id for creating and updating teams.

d4d8926

Merge branch 'main' into nested-teams

971eeb9

Cheshirez added 2 commits December 18, 2023 14:41

Add debugging assertion for parent_team_id (expects int or Null)

8393899

Signed-off-by: Andrii Kezikov <cheshirez@gmail.com>

Merge remote-tracking branch 'origin/nested-teams' into nested-teams

343c955

EnricoMi requested changes Dec 19, 2023

View reviewed changes

Cheshirez added 3 commits December 19, 2023 18:01

Add maintainers param for teams creation

637cb22

Signed-off-by: Andrii Kezikov <cheshirez@gmail.com>

Merge branch 'PyGithub:main' into nested-teams

6a8fedb

Merge remote-tracking branch 'origin/nested-teams' into nested-teams

2cfd635

EnricoMi changed the title ~~Set missing parent_team_id for creating and updating teams.~~ Add parent_team_id and maintainers for creating and updating teams. Dec 20, 2023

Cheshirez added 2 commits December 22, 2023 15:19

Add notification_setting param for teams creation and edit

b705da2

Signed-off-by: Andrii Kezikov <cheshirez@gmail.com>

Merge branch 'main' into nested-teams

1979ac6

Cheshirez changed the title ~~Add parent_team_id and maintainers for creating and updating teams.~~ Add parent_team_id, maintainers and notification_setting for creating and updating teams. Dec 22, 2023

Cheshirez requested a review from EnricoMi January 3, 2024 04:26

Merge branch 'main' into nested-teams

2850803

EnricoMi requested changes Jan 11, 2024

View reviewed changes

Cheshirez added 4 commits January 24, 2024 12:55

Merge remote-tracking branch 'upstream/main' into nested-teams

2cbe2e3

Add notification_setting param to tests

4889f6e

Signed-off-by: Andrii Kezikov <cheshirez@gmail.com>

Merge remote-tracking branch 'upstream/main' into nested-teams

d03d27e

Merge remote-tracking branch 'origin/nested-teams' into nested-teams

7b48a49

EnricoMi requested changes Jan 28, 2024

View reviewed changes

github/Organization.py Outdated Show resolved Hide resolved

github/Team.py Outdated Show resolved Hide resolved

EnricoMi mentioned this pull request Jan 28, 2024

add parent team id when calling create team function fix black precom… #2278

Closed

EnricoMi added 2 commits January 28, 2024 17:04

Remove redundant assertion

179ba9d

Merge branch 'main' into nested-teams

effb4ca

EnricoMi approved these changes Jan 28, 2024

View reviewed changes

EnricoMi merged commit 49d07d1 into PyGithub:main Jan 28, 2024
15 checks passed

Cheshirez deleted the nested-teams branch January 29, 2024 18:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add parent_team_id, maintainers and notification_setting for creating and updating teams. #2863

Add parent_team_id, maintainers and notification_setting for creating and updating teams. #2863

Cheshirez commented Dec 14, 2023

codecov-commenter commented Dec 14, 2023 •

edited

Cheshirez commented Dec 18, 2023

EnricoMi left a comment

Cheshirez commented Dec 20, 2023

EnricoMi commented Dec 20, 2023

Cheshirez commented Dec 22, 2023

Cheshirez commented Jan 26, 2024

EnricoMi left a comment

EnricoMi left a comment

Add parent_team_id, maintainers and notification_setting for creating and updating teams. #2863

Add parent_team_id, maintainers and notification_setting for creating and updating teams. #2863

Conversation

Cheshirez commented Dec 14, 2023

codecov-commenter commented Dec 14, 2023 • edited

Codecov Report

Cheshirez commented Dec 18, 2023

EnricoMi left a comment

Choose a reason for hiding this comment

Cheshirez commented Dec 20, 2023

EnricoMi commented Dec 20, 2023

Cheshirez commented Dec 22, 2023

Cheshirez commented Jan 26, 2024

EnricoMi left a comment

Choose a reason for hiding this comment

EnricoMi left a comment

Choose a reason for hiding this comment

codecov-commenter commented Dec 14, 2023 •

edited