ghec-migration 2.0.1

A Python script for bulk migrating repos from one org to other org GitHub repositories using the API

Github Enterprise cloud migration tool

This tool helps you do the below tasks

Github Migration

Migrates provided github repos from source org to target organization

Generate Github Personal Access Token

• Follow the steps here to generate personal access token. Copy the token.
• For github enterprise cloud, the token should be enabled with SAML SSO
• Follow the steps here

Access Needed

• The user who is running this tool, should be an admin on the source organization.

Make Repos private

Before running the tool for migration make all the repos private. You have to be an admin on the organization to do so

  #python3 make_private.py source_org token

  python3 make_private.py nike-platform-fulfillment <PAT token>

Running the tool

• Install python3
  • On MAC OS - brew install python3
  • On Windows, download the installer from here

Run the below command to install the github migration tool

pip3 install --upgrade ghec-migration

Invoke the tool by running ghec-migration

Output of the tool

➜  ~ ghec-migration
Github Migration
? What do you want to do?  Github Migration
? Source github org  nike-platform-fulfillment
? Target github org  nike-internal
? Target Team Slug  fulfillment-squad-artemis
? Target Team Admin Slug  fulfillment-admins
? Team Prefix  fulfillment
? Github access token  <token>
? How do you want to get the repos?  Provide list of Repos
? Provide the file with the repo names to be migrated  /Users/vmari2/repos.txt

#output

Logged in as user vmari2_nike
Reading repos from /Users/vmari2/repos.txt

Transferring publishgempoc to target organization
Adding user vmari2_nike as adming to repo publishgempoc
User vmari2_nike added as admin to the repo publishgempoc
Renaming publishgempoc to fulfillment.publishgempoc
Renamed successfully
Renaming master to main
Renamed master to main
Transferring repo publishgempoc to nike-internal
Transfer completed for repo publishgempoc
changing team level access
Changed fulfillment to be a push
Changed fulfillment-squad-artemis to be a maintain
Changed fulfillment-admins to be a admin
Changed fulfillment-external-contributors to be a push
Made publishgempoc internal after transfer
Removing user vmari2_nike as adming to repo publishgempoc
User vmari2_nike removed as admin to the repo publishgempoc
Completed transfer for publishgempoc

Jenkins Migration

We can change the github url in the bmx job using this tool

Generate a jenkins following the steps here

Github Migration
? What do you want to do?  Jenkins BMX Migration
? Update Jenkins Job with new repo  Yes
? BMX Jenkins URL  https://mpartemis.jenkins.bmx.nikecloud.com/
? Jenkins Token  <token>
? Jenkins Username  [e-mail]
? New Github Org  nike-internal
? Old Github Org(s). Provide comma separated values   mp-commerce-fulfillment
? Team Prefix  fulfillment
? Provide the new credentials to Change credentials id. Leave blank if not changing   artemiscicd

Update Topics on repos

This script finds the repos on which the given team has the provided access levels. For example, if you want to update topics on repos where fulfillment-squad-artemis has maintain access run below command

Arguments

Postion	Argument	Description
1	Source_Org	the github organization name Ex nike-internal
2	team_slug	the team slug Ex: fulfillment-squad-artemis
3	access_level	the access level for the provided team - can take values ["push", "pull", "maintain", "admin", "triage"]
4	token	github access token
5	Additional Topics	Provide common separated topics ex: fulfillment,services

How to run

python3 update_topics_for_team.py source_org team-slug access_level token additional_topics_csv

python3 update_topics_for_team.py nike-internal fulfillment-squad-artemis maintain $token fulfillment,apps

What this tool will not do

• update QMA config in service now
• Update master references to main in Code like Jenkinsfile, etc
• If you use build flows based on the branch, you have to update them accordingly
• Doesn't organize bmx jobs into folders
• It can't skip bmx jobs