Skip to main content

How To: Sync GitHub Organization Teams to Codefresh

  • Updated

As an admin, you may want to sync your GitHub Organization Teams with your Codefresh account. At the same time, you do not want to set up an SSO provider and have the users use any login provider they choose.

Solution:

The Personal Access Token (PAT) being user will sync ALL Organizations and ALL Teams to which the user has access. It is recommended to us a "machine" account to access the one organization you need.

  1. Create a PAT that has access to read organizations and teams
  2. Install and configure the Codefresh CLI
  3. codefresh synchronize teams -t github --tk $GHTOKEN [1]
  4. The sync will invite all users except for those that have private email settings turned on.

Once the initial sync happens, you can set up a cron trigger pipeline to run the command on a schedule [2]. Additionally, I would make the $GHTOKEN a shared secret in Codefresh and attach that secret to the pipeline [3].

Resources:

[1] https://codefresh-io.github.io/cli/teams/synchronize-teams/ 

[2] https://codefresh.io/docs/docs/administration/single-sign-on/sso-setup-oauth2/#syncing-of-teams-after-initial-sso-setup   

[3] https://codefresh.io/docs/docs/configure-ci-cd-pipeline/shared-configuration/#creating-shared-configuration 

Related articles