Skip to content

Commit 1342b5a

Browse files
committed
docs: clarifying these scripts are for imports
1 parent b6a3b24 commit 1342b5a

File tree

3 files changed

+13
-3
lines changed

3 files changed

+13
-3
lines changed

gh-cli/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -720,7 +720,7 @@ Gets a list of members (via GraphQL) and their role in an organization
720720

721721
### get-organization-migrations-summary.sh
722722

723-
Gets a summary of all migrations against a given organization with [GitHub Enterprise Importer](https://docs.github.com/en/migrations/using-github-enterprise-importer)
723+
Gets a summary of all migrations (imports) against a given organization with [GitHub Enterprise Importer](https://docs.github.com/en/migrations/using-github-enterprise-importer)
724724

725725
example:
726726

@@ -739,7 +739,7 @@ Total 10
739739

740740
### get-organization-migrations-tsv.sh
741741

742-
Gets a TSV with a list of migrations performed (or being performed) on a given organization with [GitHub Enterprise Importer](https://docs.github.com/en/migrations/using-github-enterprise-importer)
742+
Gets a TSV with a list of migrations (imports) performed (or being performed) on a given organization with [GitHub Enterprise Importer](https://docs.github.com/en/migrations/using-github-enterprise-importer)
743743

744744
It contains the following data:
745745

gh-cli/get-organization-migrations-summary.sh

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
#!/bin/bash
22

3+
# summarizes the most recent migration imports for a given organization
4+
5+
# gh cli's token needs to be able to admin org - run this if it fails
6+
# gh auth refresh -h github.com -s admin:org
7+
38
if [ $# -lt "1" ]; then
49
echo "Usage: $0 <organization>"
510
exit 1
@@ -9,7 +14,7 @@ organization=$1
914

1015
if ! response=$(gh api graphql -f org="$organization" -f query='query ($org: String!) {
1116
organization(login: $org) {
12-
queued : repositoryMigrations(state: QUEUED) { totalCount }
17+
queued : repositoryMigrations(state: QUEUED) {totalCount}
1318
notstarted: repositoryMigrations(state: NOT_STARTED) {totalCount}
1419
inprogress: repositoryMigrations(state: IN_PROGRESS) {totalCount}
1520
suceeded: repositoryMigrations(state: SUCCEEDED) {totalCount}

gh-cli/get-organization-migrations-tsv.sh

+5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
#!/bin/bash
22

3+
# gets a list of organization migration imports in tsv format
4+
5+
# gh cli's token needs to be able to admin org - run this if it fails
6+
# gh auth refresh -h github.com -s admin:org
7+
38
if [ $# -lt "1" ]; then
49
echo "Usage: $0 <organization> [max migrations]"
510
echo "[max migrations] is optional max value is 100. Use if you do not want to get all migrations"

0 commit comments

Comments
 (0)