magnetikonline / github-utilities

Random scripts for working with GitHub itself and repositories within.

GitHub utilities

Random scripts for working with GitHub itself and repositories. All designed for Python 3.10+.

• Utilities
  • listorganizationrepositorybysize.py
  • listorganizationrepositorywebhooks.py
  • removerepositorywiki.py
  • removerepositoryprojects.py
  • subscriberepositories.py
• Configuration
• Filter arguments
  • Examples

Utilities

listorganizationrepositorybysize.py

• Fetches all repositories for a given ORGANIZATION, ordered in descending size order.
• Emits results to the console as tab separated repository/size (kilobytes) lines.

listorganizationrepositorywebhooks.py

• Returns all repositories for a given ORGANIZATION containing one or more webhooks.
• Emits results to the console as repository lines and tab indented webhook URLs.

removerepositorywiki.py

• Scans repositories and reports all with an enabled Wiki.
• Repository checking scope can be set with the --include / --exclude filter arguments.
• With --commit argument passed will disable each wiki found.

removerepositoryprojects.py

• Scans repositories and reports all with an enabled Projects board.
• Repository checking scope can be set with the --include / --exclude filter arguments.
• With --commit argument passed will disable each project board found.

subscriberepositories.py

• By default GitHub notification settings are configured to automatically watch all repositories to which you have push access - including your own personal repositories:
  • This state works well when running solo, but association to an active organization you soon find a watch list getting very noisy with notifications.
  • Disabling Automatic watching works, but you're now left in a situation of potentially forgetting to watch your own personal repositories after creation and update of issues/PRs.
• This script fetches all repositories in scope and compares to your subscription list - reporting back repositories that aren't currently watched.
• Repository checking scope can be set with the --include / --exclude filter arguments.
• With --commit argument passed any repositories not currently watched will be subscribed to.

Configuration

All settings contained in a single config.json. A breakdown of each setting follows:

• AUTH_TOKEN - a valid GitHub token ID, generated via the Personal access tokens page. Token requires full access to the repo scope and it's sub-scopes:

  Alternatively, the token value can be supplied via a AUTH_TOKEN environment variable.

• ORGANIZATION - where required, specifies the organization to use for repository fetch.

• REPOSITORY_TYPE - when repositories are fetched - defines the context/association to to user to use.

  Valid options are listed here and here with member or owner more than likely what you're after.

Filter arguments

Certain scripts allow control of repository scope via --include and --exclude arguments, providing the ability to skip over a subset of repositories:

• Valid filter character range is [/A-Za-z0-9_.-], while a wildcard (*) will match one or more characters.
• Filters will be evaluated against a full user/repository_name or organization/repository_name value.
• An --exclude match will negate any possible --include match(es).
• If no --include filter(s) defined, default is to "match all" (e.g. --include *).

Examples

# matches "user/one" and "user/two" but not "user/one_two" or "user/three"
./script.py \
  --include "u*/one" \
  --include "u*/two"

# matches "organization/*" but not "organization/skip_me"
./script.py \
  --include "organization/*" \
  --exclude "*/skip_me"

# will match everything except "user/avoid"
./script.py \
  --exclude "user/avoid"