adding descriptions to scripts

Author: joshjohanning

scripts/README.md

@@ -70,6 +70,8 @@ Delete branch protection rules programmatically based on a pattern.
 
 ## delete-repos-from-list.sh
 
+Deletes a list of repositories.
+
 1. Run: `./generate-repos-list.sh <org> > repos.csv`
 2. Clean up the `repos.csv` file and remove the repos you **don't want to delete**
 3. Run `./delete-repos-from-list.sh repos.csv`

scripts/add-codeowners-file-to-repositories.sh

@@ -1,11 +1,11 @@
 #!/bin/bash
-# DOT NOT REMOVE TRAILING NEW LINE IN THE INPUT CSV FILE
 
-# Need to run this to get the repo delete scope: gh auth refresh -h github.com -s delete_repo
+# Adds a CODEOWNERS file to the default branch in a CSV list of repositories
 
 # Usage: 
 # Step 1: Run ./generate-repos.sh <org> > repos.csv 
-#    (or create a list of repos in a csv file, 1 per line, with a trailing empty line at the end of the file)
+#   - Or create a list of repos in a csv file, 1 per line, with a trailing empty line at the end of the file
+#   - DO NOT REMOVE TRAILING NEW LINE IN THE INPUT CSV FILE
 # Step 2: ./add-codeowners-file-to-repositories.sh repos.csv ./CODEOWNERS false
 #
 # Overwrite or append: 

scripts/add-gitignore-file-to-repositories.sh

@@ -1,11 +1,11 @@
 #!/bin/bash
-# DOT NOT REMOVE TRAILING NEW LINE IN THE INPUT CSV FILE
 
-# Need to run this to get the repo delete scope: gh auth refresh -h github.com -s delete_repo
+# Adds a .gitignore file to the default branch in a CSV list of repositories
 
 # Usage: 
 # Step 1: Run ./generate-repos.sh <org> > repos.csv 
-#    (or create a list of repos in a csv file, 1 per line, with a trailing empty line at the end of the file)
+#    - Or create a list of repos in a csv file, 1 per line, with a trailing empty line at the end of the file\
+#    - DO NOT REMOVE TRAILING NEW LINE IN THE INPUT CSV FILE
 # Step 2: ./add-gitignore-file-to-repositories.sh repos.csv ./.gitignore false
 #
 # Overwrite or append: 

scripts/add-users-to-team-from-list.sh

@@ -1,8 +1,10 @@
 #!/bin/bash
-# DOT NOT REMOVE TRAILING NEW LINE IN THE INPUT CSV FILE
+
+# Adds users to an organization team from a CSV input list
 
 # Usage: 
 # Step 1: Create a list of users in a csv file, 1 per line, with a trailing empty line at the end of the file
+#   - DO NOT REMOVE TRAILING NEW LINE IN THE INPUT CSV FILE
 # Step 2: ./add-users-to-team-from-list.sh users.csv <org> <team>
 
 if [ $# -lt "3" ]; then

scripts/create-enterprise-organizations.sh

@@ -1,5 +1,8 @@
 #!/bin/bash
-# DOT NOT REMOVE TRAILING NEW LINE IN THE INPUT CSV FILE
+
+# Creates organizations in an enterprise from a CSV input list (orgs-to-create.csv)
+
+# DO NOT REMOVE TRAILING NEW LINE IN THE INPUT CSV FILE
 
 # Use ../gh-cli/get-enterprise-id.sh to get the enterprise id to use here
 

scripts/create-teams-from-list.sh

@@ -1,13 +1,15 @@
 #!/bin/bash
-# DOT NOT REMOVE TRAILING NEW LINE IN THE INPUT CSV FILE
+
+# Creates teams in an organization from a CSV input list
 
 # Need to run this to be able to create teams: gh auth refresh -h github.com -s admin:org
 
 # Usage: 
 # Step 1: Create a list of teams in a csv file, 1 per line, with a trailing empty line at the end of the file
-#           - child teams should have a slash in the name, e.g. test1-team/test1-1-team
-#           - build out the parent structure in the input file before creating the child teams;
-#               e.g. have the 'test1-team' come before 'test1-team/test1-1-team' in the file
+#   - child teams should have a slash in the name, e.g. test1-team/test1-1-team
+#   - build out the parent structure in the input file before creating the child teams;
+#       e.g. have the 'test1-team' come before 'test1-team/test1-1-team' in the file
+#   - DO NOT REMOVE TRAILING NEW LINE IN THE INPUT CSV FILE
 # Step 2: ./create-teams-from-list.sh teams.csv <org>
 
 # Example input file:
@@ -16,7 +18,7 @@
 # test22-team
 # test11-team/test11111-team
 # test11-team/test11111-team/textxxx-team
-
+# 
 
 if [ $# -lt "2" ]; then
     echo "Usage: $0 <teams-file-name> <org>"

scripts/delete-repos-from-list.sh

@@ -1,11 +1,13 @@
 #!/bin/bash
-# DOT NOT REMOVE TRAILING NEW LINE IN THE INPUT CSV FILE
+
+# Deletes repos from a CSV input list
 
 # Need to run this to get the repo delete scope: gh auth refresh -h github.com -s delete_repo
 
 # Usage: 
 # Step 1: Run ./generate-repos.sh <org> > repos.csv 
-#    (or create a list of repos in a csv file, 1 per line, with a trailing empty line at the end of the file)
+#   - Or create a list of repos in a csv file, 1 per line, with a trailing empty line at the end of the file
+#   - DO NOT REMOVE TRAILING NEW LINE IN THE INPUT CSV FILE
 # Step 2: ./delete-repos-from-list.sh repos.csv
 
 if [ $# -lt "1" ]; then

scripts/delete-teams-from-list.sh

@@ -1,12 +1,14 @@
 #!/bin/bash
-# DOT NOT REMOVE TRAILING NEW LINE IN THE INPUT CSV FILE
+
+# Deletes teams in an organization from a CSV input list
 
 # Need to run this to be able to delete teams: gh auth refresh -h github.com -s admin:org
 
 # Usage: 
 # Step 1: Create a list of teams in a csv file, 1 per line, with a trailing empty line at the end of the file
-#           - child teams should have a slash in the name, e.g. test1-team/test1-1-team
-#           - !!! Important !!! Note that if a team has child teams, all of the child teams will be deleted as well
+#     - child teams should have a slash in the name, e.g. test1-team/test1-1-team
+#     - !!! Important !!! Note that if a team has child teams, all of the child teams will be deleted as well
+#     - DO NOT REMOVE TRAILING NEW LINE IN THE INPUT CSV FILE
 # Step 2: ./delete-teams-from-list.sh teams.csv <org>
 
 # Example input file:

scripts/gei-clean-up-azure-storage-account.sh

@@ -1,5 +1,7 @@
 #!/bin/bash
 
+# Cleans up containers from a storage account older than a specified time
+
 # modified from https://learn.microsoft.com/en-us/azure/storage/scripts/storage-blobs-container-delete-by-prefix-cli#run-the-script
 # requires GNU date.
 # if using a mac: `brew install coreutils`

scripts/generate-repos-list.sh

@@ -1,5 +1,7 @@
 #!/bin/bash
 
+# Generates a list of repositories in an organization to a CSV file
+
 # Usage: ./generate-repos.sh <org> > csv.csv
 
 # Credits to @tspascoal from this repo: https://github.com/tspascoal/dependabot-alerts-helper

scripts/generate-users-from-team.sh

@@ -1,5 +1,7 @@
 #!/bin/bash
 
+# Generate list of users from team
+
 # Usage: ./generate-users-from-team.sh <org> <team> > users.csv
 
 if [ $# -ne "2" ]; then

scripts/get-app-jwt.py

@@ -1,4 +1,7 @@
 #!/usr/bin/env python3
+
+# This script generates a JWT for a GitHub App
+
 import jwt # pip3 install jwt
 import time
 import sys

scripts/get-app-tokens-for-each-installation.sh

@@ -1,5 +1,7 @@
 #!/bin/bash
 
+# Get app tokens for each organization installation of a GitHub app
+
 # example usage: `./get-app-tokens-for-each-installation.sh 314893 ./test-for-jwt-app-auth.2023-04-06.private-key.pem`
 
 if [ -z "$2" ]; then

scripts/get-new-outside-collaborators-added-to-repository.sh

@@ -1,5 +1,7 @@
 #!/bin/bash
 
+# Get new outside collaborators added to a repository since the last time this script was run
+
 # Usage: 
 # Step 1: ./new-users-to-add-to-project.sh <org> <repo> <file>
 # Step 2: Don't delete the `<file>` as it functions as your user database

scripts/remove-users-from-org.sh

@@ -1,8 +1,10 @@
 #!/bin/bash
-# DOT NOT REMOVE TRAILING NEW LINE IN THE INPUT CSV FILE
+
+# Remove users from an organization from a CSV input list
 
 # Usage: 
 # Step 1: Create a list of users in a csv file, 1 per line, with a trailing empty line at the end of the file (or use ./generate-users-from-team <org> <team>)
+#   - DO NOT REMOVE TRAILING NEW LINE IN THE INPUT CSV FILE
 # Step 2: ./remove-users-from-org.sh <file> <org>
 
 if [ $# -ne "2" ]; then

scripts/verify-team-membership.sh

@@ -1,5 +1,7 @@
 #!/bin/bash
 
+# Verify if a specified user is a member of a team
+
 members=$(gh api --paginate /orgs/joshjohanning-org/teams/approver-team/members --jq='.[] | [.login] | join(",")')
 
 themember="joshjohanning"