Skip to content

Commit d866b4d

Browse files
📝 document the configuration file
1 parent 727f183 commit d866b4d

1 file changed

Lines changed: 14 additions & 2 deletions

File tree

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,21 @@ Groups (currently Azure Active Directory Only) to GitHub Teams sync
44

55
[![Publish Docker image](https://github.com/cloudpups/github-teams-user-sync/actions/workflows/docker-image.yml/badge.svg?branch=main)](https://github.com/cloudpups/github-teams-user-sync/actions/workflows/docker-image.yml) [![Docker Pulls](https://img.shields.io/docker/pulls/trfc/github-teams-user-sync)](https://hub.docker.com/r/trfc/github-teams-user-sync)
66

7-
## Some Sparse Documentation (to be updated)
7+
## Configuration File
88

9-
## Configuration of this tool
9+
This service/Action requires that a configuration file be present in the `.github` repository of your GitHub Organization. An example of this is show below:
10+
11+
Filename: `team-sync-options.yaml`
12+
```yaml
13+
# This property is used to control the addition of general Members to your Organization.
14+
OrganizationMembersGroup: Some_Group_To_Sync_For_Organization_Membership
15+
# This property is used for syncing all other GitHub Teams. Please note that users must also be a part of the `OrganizationMembersGroup` for the synchronization of the teams below to function properly.
16+
GitHubTeamNames:
17+
- Some_Team_To_Sync
18+
- Some_Other_Team_To_Sync
19+
```
20+
21+
## Necessary configuration of the tool/service
1022
1123
As of this writing, this sync tool can be ran as a standalone app, or as a GitHub Action.
1224

0 commit comments

Comments
 (0)