Merge pull request #561 from gm3dmo/powersmash

gm3dmo · web-flow · commit 6df8958f52e5 · 2026-04-12T12:23:37.000+01:00
Copilot makes a contribution
diff --git a/add-app-access-restrictions.sh b/add-app-access-restrictions.sh
@@ -0,0 +1,26 @@
+.  ./.gh-api-examples.conf
+
+# https://docs.github.com/en/rest/branches/branch-protection?apiVersion=2022-11-28#add-app-access-restrictions
+# POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps
+
+branch=${protected_branch_name}
+
+if [ -z "$1" ]
+  then
+    app_slug="${app_slug}"
+  else
+    app_slug=$1
+fi
+
+json_file=tmp/add-app-access-restrictions.json
+jq -n \
+       --arg app_slug "${app_slug}" \
+       '{
+         apps: [ $app_slug ]
+       }' > ${json_file}
+
+curl ${curl_custom_flags} \
+     -X POST \
+     -H "Accept: application/vnd.github.v3+json" \
+     -H "Authorization: Bearer ${GITHUB_TOKEN}" \
+        "${GITHUB_API_BASE_URL}/repos/${org}/${repo}/branches/${branch}/protection/restrictions/apps" --data @${json_file}
diff --git a/add-collaborator-to-repo.sh b/add-collaborator-to-repo.sh
@@ -1,20 +1,34 @@
-.   ./.gh-api-examples.conf
+.  ./.gh-api-examples.conf
 
 # https://docs.github.com/en/rest/collaborators/collaborators?apiVersion=2022-11-28#add-a-repository-collaborator
 # PUT /repos/{owner}/{repo}/collaborators/{username}
 
 # limits: https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository
 
 
-username=${repo_collaborator}
+# If the script is passed an argument $1 use that as the name
+if [ -z "$1" ]
+  then
+    username=${repo_collaborator}
+  else
+    username=$1
+fi
+
 permission=${2:-push}
 
-JSON_TEMPLATE='{"permission":"%s"}'
-JSON_DATA=$(printf "$JSON_TEMPLATE" "$permission")
+json_file=tmp/add-collaborator-to-repo.json
+
+jq -n \
+           --arg permission "${permission}" \
+           '{
+             permission : $permission,
+           }' > ${json_file}
+
 
 curl ${curl_custom_flags} \
      -X PUT \
-     -H "Accept: application/vnd.github.v3+json" \
+     -H "X-GitHub-Api-Version: ${github_api_version}" \
+     -H "Accept: application/vnd.github+json" \
      -H "Authorization: Bearer ${GITHUB_TOKEN}" \
-        "${GITHUB_API_BASE_URL}/repos/${org}/${repo}/collaborators/${username}" -d ${JSON_DATA}
+        "${GITHUB_API_BASE_URL}/repos/${org}/${repo}/collaborators/${username}" --data @${json_file}
 
diff --git a/add-status-check-contexts.sh b/add-status-check-contexts.sh
@@ -0,0 +1,19 @@
+.  ./.gh-api-examples.conf
+
+# https://docs.github.com/en/rest/branches/branch-protection?apiVersion=2022-11-28#add-status-check-contexts
+# POST /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts
+
+branch=${protected_branch_name}
+
+json_file=tmp/add-status-check-contexts.json
+jq -n \
+       --arg required_status_check_name "${required_status_check_name}" \
+       '{
+         contexts: [ $required_status_check_name ]
+       }' > ${json_file}
+
+curl ${curl_custom_flags} \
+     -X POST \
+     -H "Accept: application/vnd.github.v3+json" \
+     -H "Authorization: Bearer ${GITHUB_TOKEN}" \
+        "${GITHUB_API_BASE_URL}/repos/${org}/${repo}/branches/${branch}/protection/required_status_checks/contexts" --data @${json_file}
diff --git a/add-team-access-restrictions.sh b/add-team-access-restrictions.sh
@@ -0,0 +1,19 @@
+.  ./.gh-api-examples.conf
+
+# https://docs.github.com/en/rest/branches/branch-protection?apiVersion=2022-11-28#add-team-access-restrictions
+# POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams
+
+branch=${protected_branch_name}
+
+json_file=tmp/add-team-access-restrictions.json
+jq -n \
+       --arg team_slug "${team_slug}" \
+       '{
+         teams: [ $team_slug ]
+       }' > ${json_file}
+
+curl ${curl_custom_flags} \
+     -X POST \
+     -H "Accept: application/vnd.github.v3+json" \
+     -H "Authorization: Bearer ${GITHUB_TOKEN}" \
+        "${GITHUB_API_BASE_URL}/repos/${org}/${repo}/branches/${branch}/protection/restrictions/teams" --data @${json_file}
diff --git a/check-if-a-user-is-a-repository-collaborator.sh b/check-if-a-user-is-a-repository-collaborator.sh
@@ -0,0 +1,20 @@
+.  ./.gh-api-examples.conf
+
+# https://docs.github.com/en/rest/collaborators/collaborators?apiVersion=2022-11-28#check-if-a-user-is-a-repository-collaborator
+# GET /repos/{owner}/{repo}/collaborators/{username}
+
+
+if [ -z "$1" ]
+  then
+    username=${repo_collaborator}
+  else
+    username=$1
+fi
+
+
+set -x
+curl ${curl_custom_flags} \
+     -H "X-GitHub-Api-Version: ${github_api_version}" \
+     -H "Accept: application/vnd.github+json" \
+     -H "Authorization: Bearer ${GITHUB_TOKEN}" \
+        "${GITHUB_API_BASE_URL}/repos/${owner}/${repo}/collaborators/${username}"
diff --git a/create-commit-signature-protection.sh b/create-commit-signature-protection.sh
@@ -0,0 +1,12 @@
+.  ./.gh-api-examples.conf
+
+# https://docs.github.com/en/rest/branches/branch-protection?apiVersion=2022-11-28#create-commit-signature-protection
+# POST /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures
+
+branch=${protected_branch_name}
+
+curl ${curl_custom_flags} \
+     -X POST \
+     -H "Accept: application/vnd.github.v3+json" \
+     -H "Authorization: Bearer ${GITHUB_TOKEN}" \
+        "${GITHUB_API_BASE_URL}/repos/${org}/${repo}/branches/${branch}/protection/required_signatures"
diff --git a/delete-access-restrictions.sh b/delete-access-restrictions.sh
@@ -0,0 +1,12 @@
+.  ./.gh-api-examples.conf
+
+# https://docs.github.com/en/rest/branches/branch-protection?apiVersion=2022-11-28#delete-access-restrictions
+# DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions
+
+branch=${protected_branch_name}
+
+curl ${curl_custom_flags} \
+     -X DELETE \
+     -H "Accept: application/vnd.github.v3+json" \
+     -H "Authorization: Bearer ${GITHUB_TOKEN}" \
+        "${GITHUB_API_BASE_URL}/repos/${org}/${repo}/branches/${branch}/protection/restrictions"
diff --git a/delete-admin-branch-protection.sh b/delete-admin-branch-protection.sh
@@ -0,0 +1,12 @@
+.  ./.gh-api-examples.conf
+
+# https://docs.github.com/en/rest/branches/branch-protection?apiVersion=2022-11-28#delete-admin-branch-protection
+# DELETE /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins
+
+branch=${protected_branch_name}
+
+curl ${curl_custom_flags} \
+     -X DELETE \
+     -H "Accept: application/vnd.github.v3+json" \
+     -H "Authorization: Bearer ${GITHUB_TOKEN}" \
+        "${GITHUB_API_BASE_URL}/repos/${org}/${repo}/branches/${branch}/protection/enforce_admins"
diff --git a/delete-commit-signature-protection.sh b/delete-commit-signature-protection.sh
@@ -0,0 +1,12 @@
+.  ./.gh-api-examples.conf
+
+# https://docs.github.com/en/rest/branches/branch-protection?apiVersion=2022-11-28#delete-commit-signature-protection
+# DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures
+
+branch=${protected_branch_name}
+
+curl ${curl_custom_flags} \
+     -X DELETE \
+     -H "Accept: application/vnd.github.v3+json" \
+     -H "Authorization: Bearer ${GITHUB_TOKEN}" \
+        "${GITHUB_API_BASE_URL}/repos/${org}/${repo}/branches/${branch}/protection/required_signatures"
diff --git a/delete-pull-request-review-protection.sh b/delete-pull-request-review-protection.sh
@@ -0,0 +1,12 @@
+.  ./.gh-api-examples.conf
+
+# https://docs.github.com/en/rest/branches/branch-protection?apiVersion=2022-11-28#delete-pull-request-review-protection
+# DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews
+
+branch=${protected_branch_name}
+
+curl ${curl_custom_flags} \
+     -X DELETE \
+     -H "Accept: application/vnd.github.v3+json" \
+     -H "Authorization: Bearer ${GITHUB_TOKEN}" \
+        "${GITHUB_API_BASE_URL}/repos/${org}/${repo}/branches/${branch}/protection/required_pull_request_reviews"
diff --git a/get-a-deploy-key.sh b/get-a-deploy-key.sh
@@ -0,0 +1,17 @@
+.  ./.gh-api-examples.conf
+
+# https://docs.github.com/en/enterprise-cloud@latest/rest/deploy-keys/deploy-keys?apiVersion=2022-11-28#get-a-deploy-key
+# GET /repos/{owner}/{repo}/keys/{key_id}
+
+if [ -z "$1" ]
+  then
+    key_id=$(./list-deploy-keys.sh | jq -r '.[0].id')
+  else
+    key_id=$1
+fi
+
+curl ${curl_custom_flags} \
+     -H "X-GitHub-Api-Version: ${github_api_version}" \
+     -H "Accept: application/vnd.github.v3+json" \
+     -H "Authorization: Bearer ${GITHUB_TOKEN}" \
+        "${GITHUB_API_BASE_URL}/repos/${owner}/${repo}/keys/${key_id}"
diff --git a/get-access-restrictions.sh b/get-access-restrictions.sh
@@ -0,0 +1,11 @@
+.  ./.gh-api-examples.conf
+
+# https://docs.github.com/en/rest/branches/branch-protection?apiVersion=2022-11-28#get-access-restrictions
+# GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions
+
+branch=${protected_branch_name}
+
+curl ${curl_custom_flags} \
+     -H "Accept: application/vnd.github.v3+json" \
+     -H "Authorization: Bearer ${GITHUB_TOKEN}" \
+        "${GITHUB_API_BASE_URL}/repos/${org}/${repo}/branches/${branch}/protection/restrictions"
diff --git a/get-admin-branch-protection.sh b/get-admin-branch-protection.sh
@@ -0,0 +1,11 @@
+.  ./.gh-api-examples.conf
+
+# https://docs.github.com/en/rest/branches/branch-protection?apiVersion=2022-11-28#get-admin-branch-protection
+# GET /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins
+
+branch=${protected_branch_name}
+
+curl ${curl_custom_flags} \
+     -H "Accept: application/vnd.github.v3+json" \
+     -H "Authorization: Bearer ${GITHUB_TOKEN}" \
+        "${GITHUB_API_BASE_URL}/repos/${org}/${repo}/branches/${branch}/protection/enforce_admins"
diff --git a/get-all-status-check-contexts.sh b/get-all-status-check-contexts.sh
@@ -0,0 +1,11 @@
+.  ./.gh-api-examples.conf
+
+# https://docs.github.com/en/rest/branches/branch-protection?apiVersion=2022-11-28#get-all-status-check-contexts
+# GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts
+
+branch=${protected_branch_name}
+
+curl ${curl_custom_flags} \
+     -H "Accept: application/vnd.github.v3+json" \
+     -H "Authorization: Bearer ${GITHUB_TOKEN}" \
+        "${GITHUB_API_BASE_URL}/repos/${org}/${repo}/branches/${branch}/protection/required_status_checks/contexts"
diff --git a/get-apps-with-access-to-the-protected-branch.sh b/get-apps-with-access-to-the-protected-branch.sh
@@ -0,0 +1,11 @@
+.  ./.gh-api-examples.conf
+
+# https://docs.github.com/en/rest/branches/branch-protection?apiVersion=2022-11-28#get-apps-with-access-to-the-protected-branch
+# GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps
+
+branch=${protected_branch_name}
+
+curl ${curl_custom_flags} \
+     -H "Accept: application/vnd.github.v3+json" \
+     -H "Authorization: Bearer ${GITHUB_TOKEN}" \
+        "${GITHUB_API_BASE_URL}/repos/${org}/${repo}/branches/${branch}/protection/restrictions/apps"
diff --git a/get-pull-request-review-protection.sh b/get-pull-request-review-protection.sh
@@ -0,0 +1,11 @@
+.  ./.gh-api-examples.conf
+
+# https://docs.github.com/en/rest/branches/branch-protection?apiVersion=2022-11-28#get-pull-request-review-protection
+# GET /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews
+
+branch=${protected_branch_name}
+
+curl ${curl_custom_flags} \
+     -H "Accept: application/vnd.github.v3+json" \
+     -H "Authorization: Bearer ${GITHUB_TOKEN}" \
+        "${GITHUB_API_BASE_URL}/repos/${org}/${repo}/branches/${branch}/protection/required_pull_request_reviews"
diff --git a/get-status-checks-protection.sh b/get-status-checks-protection.sh
@@ -0,0 +1,11 @@
+.  ./.gh-api-examples.conf
+
+# https://docs.github.com/en/rest/branches/branch-protection?apiVersion=2022-11-28#get-status-checks-protection
+# GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks
+
+branch=${protected_branch_name}
+
+curl ${curl_custom_flags} \
+     -H "Accept: application/vnd.github.v3+json" \
+     -H "Authorization: Bearer ${GITHUB_TOKEN}" \
+        "${GITHUB_API_BASE_URL}/repos/${org}/${repo}/branches/${branch}/protection/required_status_checks"
diff --git a/get-teams-with-access-to-the-protected-branch.sh b/get-teams-with-access-to-the-protected-branch.sh
@@ -0,0 +1,11 @@
+.  ./.gh-api-examples.conf
+
+# https://docs.github.com/en/rest/branches/branch-protection?apiVersion=2022-11-28#get-teams-with-access-to-the-protected-branch
+# GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams
+
+branch=${protected_branch_name}
+
+curl ${curl_custom_flags} \
+     -H "Accept: application/vnd.github.v3+json" \
+     -H "Authorization: Bearer ${GITHUB_TOKEN}" \
+        "${GITHUB_API_BASE_URL}/repos/${org}/${repo}/branches/${branch}/protection/restrictions/teams"
diff --git a/get-users-with-access-to-the-protected-branch.sh b/get-users-with-access-to-the-protected-branch.sh
@@ -0,0 +1,11 @@
+.  ./.gh-api-examples.conf
+
+# https://docs.github.com/en/rest/branches/branch-protection?apiVersion=2022-11-28#get-users-with-access-to-the-protected-branch
+# GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users
+
+branch=${protected_branch_name}
+
+curl ${curl_custom_flags} \
+     -H "Accept: application/vnd.github.v3+json" \
+     -H "Authorization: Bearer ${GITHUB_TOKEN}" \
+        "${GITHUB_API_BASE_URL}/repos/${org}/${repo}/branches/${branch}/protection/restrictions/users"
diff --git a/list-check-run-annotations.sh b/list-check-run-annotations.sh
@@ -0,0 +1,16 @@
+.  ./.gh-api-examples.conf
+
+# https://docs.github.com/en/enterprise-cloud@latest/rest/checks/runs?apiVersion=2022-11-28#list-check-run-annotations
+# GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations
+
+if [ -z "$1" ]
+  then
+    check_run_id=$(./list-check-runs-for-a-git-reference.sh $target_branch |   jq -r '.check_runs | last | .id')
+  else
+    check_run_id=$1
+fi
+
+curl  ${curl_custom_flags} \
+     -H "Accept: application/vnd.github.v3+json" \
+     -H "Authorization: Bearer ${GITHUB_TOKEN}" \
+        "${GITHUB_API_BASE_URL}/repos/${org}/${repo}/check-runs/${check_run_id}/annotations"
diff --git a/merge-a-branch.sh b/merge-a-branch.sh
@@ -0,0 +1,26 @@
+.  ./.gh-api-examples.conf
+
+# https://docs.github.com/en/enterprise-cloud@latest/rest/branches/branches?apiVersion=2022-11-28#merge-a-branch
+# POST /repos/{owner}/{repo}/merges
+
+if [ -z "$1" ]
+  then
+    base=${base_branch}
+  else
+    base=$1
+fi
+
+if [ -z "$2" ]
+  then
+    head="${branch_name}"
+  else
+    head=$2
+fi
+
+curl ${curl_custom_flags} \
+     -X POST \
+     -H "X-GitHub-Api-Version: ${github_api_version}" \
+     -H "Accept: application/vnd.github.v3+json" \
+     -H "Authorization: Bearer ${GITHUB_TOKEN}" \
+        "${GITHUB_API_BASE_URL}/repos/${org}/${repo}/merges" \
+        -d "{\"base\":\"${base}\",\"head\":\"${head}\"}"
diff --git a/post-add-user-access-restrictions.sh b/post-add-user-access-restrictions.sh
@@ -0,0 +1,26 @@
+.  ./.gh-api-examples.conf
+
+# https://docs.github.com/en/rest/branches/branch-protection?apiVersion=2022-11-28#add-user-access-restrictions
+# POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users
+
+branch=${protected_branch_name}
+
+if [ -z "$1" ]
+  then
+    username="${team_admin}"
+  else
+    username=$1
+fi
+
+json_file=tmp/post-add-user-access-restrictions.json
+jq -n \
+       --arg username "${username}" \
+       '{
+         users: [ $username ]
+       }' > ${json_file}
+
+curl ${curl_custom_flags} \
+     -X POST \
+     -H "Accept: application/vnd.github.v3+json" \
+     -H "Authorization: Bearer ${GITHUB_TOKEN}" \
+        "${GITHUB_API_BASE_URL}/repos/${org}/${repo}/branches/${branch}/protection/restrictions/users" --data @${json_file}
diff --git a/remove-a-repository-collaborator.sh b/remove-a-repository-collaborator.sh
@@ -6,7 +6,7 @@
 
 if [ -z "$1" ]
   then
-    username=${default_collaborator}
+    username=${repo_collaborator}
   else
     username=$1
 fi
diff --git a/remove-app-access-restrictions.sh b/remove-app-access-restrictions.sh
diff --git a/remove-status-check-protection.sh b/remove-status-check-protection.sh
diff --git a/remove-team-access-restrictions.sh b/remove-team-access-restrictions.sh
diff --git a/remove-user-access-restrictions.sh b/remove-user-access-restrictions.sh
diff --git a/rename-a-branch.sh b/rename-a-branch.sh
diff --git a/set-admin-branch-protection.sh b/set-admin-branch-protection.sh
diff --git a/set-app-access-restrictions.sh b/set-app-access-restrictions.sh
diff --git a/set-status-check-contexts.sh b/set-status-check-contexts.sh
diff --git a/sync-a-fork-branch-with-the-upstream-repository.sh b/sync-a-fork-branch-with-the-upstream-repository.sh
diff --git a/update-pull-request-review-protection.sh b/update-pull-request-review-protection.sh
diff --git a/update-status-check-protection.sh b/update-status-check-protection.sh
