Merge pull request #46 from OpenRailAssociation/more-team-settings

Synchronise all team settings

README.md

@@ -18,12 +18,19 @@ The basic principle: all settings reside in YAML configuration files which will
 ## Features
 
 * Manage GitHub organization owners
-* Manage GitHub teams and their members and maintainers
-* Support of sub-teams
+* Manage GitHub teams, their members, maintainers and settings
+* Support of parent/child teams
 * Manage teams' permissions on organizations' repositories
 * Invite members to the organization if they aren't part of it yet
 * Warn about unmanaged teams
 * Warn about organization members who are not part of any team
+* Handle individual collaborator permissions to repositories
+
+The tool's philosophy:
+
+* All relevant configuration shall happen in the YAML configuration files, no actions in GitHub UI shall be necessary.
+* All repository permissions shall be managed by team membership. Outside collaborators and individual permissions are discouraged.
+* All teams shall be managed by this tool. While it can deal with unmanaged teams, it's not a priority and may cause warnings.
 
 Are you missing a feature? Please check whether it's [already posted as an issue](https://github.com/OpenRailAssociation/github-org-manager/issues), and create one of this isn't the case.
 

config/example/org.yaml

@@ -10,3 +10,16 @@ org_name: example-org-on-github
 # List of owners of the GitHub organisation
 org_owners:
   - octocat
+
+# Default settings. Will be overridden if set in a team.
+# If neither defaults nor team settings are present:
+# - when creating a new team, will take GitHub's defaults.
+# - when syncing setting of a team, will not touch the current status.
+defaults:
+  team:
+    # Description of a team
+    description: ""
+    # Level of privacy of a team. Can be "secret" or "closed"
+    privacy: "closed"
+    # Notification setting of a team. Can be "notifications_enabled" or "notifications_disabled"
+    notification_setting: "notifications_enabled"

config/example/teams/myteams.yaml

@@ -2,7 +2,14 @@
 # SPDX-License-Identifier: CC0-1.0
 
 # A Team with its name
-Maintainers:
+Project Team:
+  # Description of the team
+  description: "My awesome Maintainers team"
+  # Level of privacy of the team. Can be "secret" or "closed". Note: parent/child teams cannot be "secret"
+  privacy: "closed"
+  # Notification setting of the team.
+  # Can be "notifications_enabled" or "notifications_disabled"
+  notification_setting: "notifications_enabled"
   # Team maintainers, can add new people and change team settings
   maintainer:
     - octocat
@@ -13,12 +20,15 @@ Maintainers:
   # The repositories the team shall have access to with a certain permission
   # Can be one of: pull, triage, push, maintain, admin
   repos:
-    cool-repository: admin
-    other-repo: admin
+    cool-repository: push
+    other-repo: push
 
-Subproject:
+Project Maintainers:
+  # Make this a child team of the provided parent. Note: You should first
+  # describe parents in this file, then children
   parent: Maintainers
   member:
-    - user2
+    - octocat
   repos:
-    cool-repository: maintain
+    cool-repository: admin
+    other-repo: maintain

gh_org_mgr/_config.py

@@ -85,7 +85,7 @@ def _read_config_file(file: str) -> dict:
     return config
 
 
-def parse_config_files(path: str) -> tuple[dict, dict, dict]:
+def parse_config_files(path: str) -> tuple[dict[str, str | dict[str, str]], dict, dict]:
     """Parse all relevant files in the configuration directory. Returns a tuple
     of org config, app config, and merged teams config"""
     # Find the relevant config files for app, org, and teams