feat: adding migration scripts

Author: joshjohanning

gh-cli/README.md

@@ -442,6 +442,10 @@ This DELETES *ALL* workflow runs for a particular workflow in a repo. Can pass i
 
 This disables all workflows in a repository; helpful if forking or copying someone else's code and you don't want all of the actions to continuously trigger.
 
+### download-migration-archive-for-repository.sh
+
+Downloads the most recent migration archive/export for a given organization repository.
+
 ### download-private-release-artifact.sh
 
 Downloads a release artifact from a private/internal repository. Can either download latest version or specific version, and supports file pattern matching to download one or multiple files. See [docs](https://cli.github.com/manual/gh_release_download) for more info.
@@ -657,6 +661,14 @@ Gets the status of a [GitHub Enterprise Importer (GEI) migration](https://docs.g
 
 Gets the usage of a label in a repository. Returns data in table format.
 
+### get-most-recent-migration-id-for-organization.sh
+
+Returns the most recent migration ID for a given organization.
+
+### get-most-recent-migration-id-for-repository.sh
+
+Returns the most recent migration ID for a given organization repository.
+
 ### get-organization-active-repositories.sh
 
 Gets a list of repositories in an organization that have had code pushed to it in the last X days.
@@ -741,6 +753,10 @@ It contains the following data:
 
 By default, it returns all migrations, but there is an optional `max-migrations` parameter to limit the number of migrations returned (must lower or equal to 100)).
 
+### get-organization-migrations.sh
+
+Returns the migrations (exports) against an organization.
+
 ### get-organization-repositories-by-property.sh
 
 Gets a list of repositories in an organization that have one or more given [custom properties](https://docs.github.com/en/enterprise-cloud@latest/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization) values.
@@ -1006,6 +1022,10 @@ Example output:
 ],
 ```
 
+### lock-repository-with-migration.sh
+
+Creates a (mostly) empty migration for a given organization repository so that it can create a lock.
+
 ### parent-organization-teams.sh
 
 Sets the parents of teams in an target organization based on existing child/parent relationship on a source organization teams.
@@ -1128,6 +1148,14 @@ Notable caps on the API:
 - 500 requests per 24 hours for organizations on paid plans
 - these caps do not apply to Enterprise Managed Users (EMU)
 
+### unlock-repository-migration-by-id.sh
+
+Unlocks / deletes the lock for a migrated repository - requires the migration ID to be passed in.
+
+### unlock-repository-migration.sh
+
+Unlocks / deletes the lock for a migrated repository by getting the most recent migration ID and unlocking it.
+
 ### update-branch-protection-rule.sh
 
 Updates a branch protection rule for a given branch.

gh-cli/download-migration-archive-for-repository.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+# downloads the most recent migration archive/export for a given organization repository
+# gets the most recent migration id for a given organization repository and then tries to download the archive
+
+if [ -z "$2" ]; then
+  echo "Usage: $0 <org> <repo>"
+  echo "Example: ./download-migration-archive-for-repository.sh joshjohanning-org test-repo-export"
+  exit 1
+fi
+
+org="$1"
+repo="$2"
+
+id=$(./get-most-recent-migration-id-for-repository.sh $org $repo true)
+
+gh api /orgs/$org/migrations/$id/archive > $repo-archive.tar.gz

gh-cli/get-most-recent-migration-id-for-organization.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+# returns the most recent migration ID for a given organization
+
+if [ -z "$1" ]; then
+  echo "Usage: $0 <org>"
+  echo "Example: ./get-most-recent-migration-id-for-organization.sh joshjohanning-org"
+  exit 1
+fi
+
+org="$1"
+
+gh api /orgs/joshjohanning-org/migrations --jq 'sort_by(.created_at) | last | .id'

gh-cli/get-most-recent-migration-id-for-repository.sh

@@ -0,0 +1,24 @@
+#!/bin/bash
+
+# returns the most recent migration ID for a given organization repository
+# pass in true as the third argument to return only the migration id
+
+if [ -z "$2" ]; then
+  echo "Usage: $0 <org> <repo> <return-id-only: true|false>"
+  echo "Example: ./get-most-recent-migration-id-for-repository.sh joshjohanning-org test-repo-export"
+  exit 1
+fi
+
+org="$1"
+repo="$2"
+return_only_id=${3:-false}
+
+migrations=$(gh api -X GET /orgs/$org/migrations -F per_page=100 --jq '.[] | {id: .id, repositories: .repositories.[].full_name, state: .state, created_at: .created_at}')
+
+if [ "$return_only_id" = "false" ]; then
+  most_recent_migration=$(echo "$migrations" | jq -s -r --arg repo "$org/$repo" 'map(select(.repositories == $repo)) | sort_by(.created_at) | last')
+else
+  most_recent_migration=$(echo "$migrations" | jq -s -r --arg repo "$org/$repo" 'map(select(.repositories == $repo)) | sort_by(.created_at) | last | .id')
+fi
+
+echo "$most_recent_migration"

gh-cli/get-organization-migrations.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+# this returns the migrations (exports) against an organization
+
+if [ -z "$1" ]; then
+  echo "Usage: $0 <org>"
+  echo "Example: ./get-organization-migrations.sh joshjohanning-org"
+  exit 1
+fi
+
+org="$1"
+
+gh api -X GET /orgs/$org/migrations -F per_page=100 --jq '.[] | {id: .id, repositories: .repositories.[].full_name, state: .state, created_at: .created_at}'

gh-cli/lock-repository-with-migration.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+# creates a (mostly) empty migration for a given organization repository so that it can create a lock
+
+if [ -z "$2" ]; then
+  echo "Usage: $0 <org> <repo>"
+  echo "Example: ./lock-repository-with-migration.sh joshjohanning-org test-repo-export"
+  exit 1
+fi
+
+org="$1"
+repo="$2"
+
+gh api -X POST /orgs/$org/migrations -f "repositories[]=$org/$repo" -F lock_repositories=true -f "exclude[]=repositories" --jq '{id: .id, state: .state, updated_at: .updated_at}'

gh-cli/unlock-repository-migration-by-id.sh

@@ -0,0 +1,19 @@
+#!/bin/bash
+
+# unlocks / deletes the lock for a migrated repository
+# you need to get the migration id first; ./get-most-recent-migration-id-for-repository.sh joshjohanning-org test-repo-export
+
+# Note: Use this other script to automatically look up the migration id for the repository: 
+# ./unlock-migrated-repository.sh joshjohanning-org test-repo-export
+
+if [ -z "$2" ]; then
+  echo "Usage: $0 <org> <migration-id>"
+  echo "Example: ./unlock-repository-migration-by-id.sh joshjohanning-org test-repo-export 4451412"
+  exit 1
+fi
+
+org="$1"
+repo="$2"
+id="$3"
+
+gh api -X DELETE /orgs/$org/migrations/$id/repos/$repo/lock

gh-cli/unlock-repository-migration.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+# unlocks / deletes the lock for a migrated repository
+# gets the most recent migration id for a given organization repository and then tries to delete the lock
+
+if [ -z "$2" ]; then
+  echo "Usage: $0 <org> <repo>"
+  echo "Example: ./unlock-repository-migration.sh joshjohanning-org test-repo-export"
+  exit 1
+fi
+
+org="$1"
+repo="$2"
+
+id=$(./get-most-recent-migration-id-for-repository.sh $org $repo true)
+
+gh api -X DELETE /orgs/$org/migrations/$id/repos/test-repo-export/lock