aboutsummaryrefslogtreecommitdiff
path: root/applications/github
diff options
context:
space:
mode:
authorChristian Cleberg <hello@cleberg.net>2025-08-02 13:02:43 -0500
committerChristian Cleberg <hello@cleberg.net>2025-08-02 13:02:43 -0500
commitb598a79d270b3a91b0e6d5f3b9dca4aecca2dd4c (patch)
tree5faf22af7a20ea6f7639fa3bdbde5210144959e6 /applications/github
parenta24b16d1c04f396209d1e80168f5df12e79bc438 (diff)
downloadaudit-tools-b598a79d270b3a91b0e6d5f3b9dca4aecca2dd4c.tar.gz
audit-tools-b598a79d270b3a91b0e6d5f3b9dca4aecca2dd4c.tar.bz2
audit-tools-b598a79d270b3a91b0e6d5f3b9dca4aecca2dd4c.zip
fix: convert README.org to README.md
Diffstat (limited to 'applications/github')
-rw-r--r--applications/github/README.md (renamed from applications/github/README.org)65
1 files changed, 33 insertions, 32 deletions
diff --git a/applications/github/README.org b/applications/github/README.md
index d707277..3ea076b 100644
--- a/applications/github/README.org
+++ b/applications/github/README.md
@@ -1,23 +1,25 @@
-#+title: GitHub Scripts
-
-*NOTE*: I used the same [[https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens][PAT]] for all scripts within this folder. Note that you can likely reduce permissions for certain scripts - it's best practice to define a PAT for a specific purpose and avoid using a single PAT with broad permissions.
+**NOTE**: I used the same
+[PAT](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)
+for all scripts within this folder. Note that you can likely reduce
+permissions for certain scripts - it's best practice to define a PAT for
+a specific purpose and avoid using a single PAT with broad permissions.
- Personal Access Token:
- - [x] Repository Permissions
- - [x] Actions: read-only
- - [x] Contents: read-only
- - [x] Metadata: read-only
- - [x] Workflows: read-only
- - [x] Organization Permissions
- - [x] Administration: read-only
+ - \[x\] Repository Permissions
+ - \[x\] Actions: read-only
+ - \[x\] Contents: read-only
+ - \[x\] Metadata: read-only
+ - \[x\] Workflows: read-only
+ - \[x\] Organization Permissions
+ - \[x\] Administration: read-only
-* =github_admins.py=
+# `github_admins.py`
-#+begin_src sh
+``` bash
python ./github_admins.py
-#+end_src
+```
-#+begin_src text
+``` text
Members of the organization 'your_organization':
Repositories in the organization 'your_organization':
@@ -25,28 +27,27 @@ Repositories in the organization 'your_organization':
Collaborators for the repository 'demo-repository':
- user1: admin
-#+end_src
+```
-* =github_audit_log.py=
+# `github_audit_log.py`
-*NOTE*: Requires an active GitHub Enterprise subscription.
+**NOTE**: Requires an active GitHub Enterprise subscription.
-#+begin_src sh
+``` bash
python ./github_audit_log.py
-#+end_src
+```
-#+begin_src text
+``` text
TODO: Need to get an Enterprise subscription to test this script.
-#+end_src
-
-* =github_branch_protections.py=
+```
+# `github_branch_protections.py`
-#+begin_src sh
+``` bash
python ./github_branch_protections.py
-#+end_src
+```
-#+begin_src text
+``` text
Total branches in the repository 'demo-repository': 1
Branch: main
@@ -54,15 +55,15 @@ No protection settings
Repository rulesets for 'demo-repository':
[{'id': 2311373, 'name': 'default', 'target': 'branch', 'source_type': 'Repository', 'source': 'phryq/demo-repository', 'enforcement': 'active', 'node_id': 'RRS_lACqUmVwb3NpdG9yec40LV1PzgAjRM0', '_links': {'self': {'href': 'https://api.github.com/repos/phryq/demo-repository/rulesets/2311373'}, 'html': {'href': 'https://github.com/phryq/demo-repository/rules/2311373'}}, 'created_at': '2024-10-19T15:59:35.200-05:00', 'updated_at': '2024-10-19T15:59:35.200-05:00'}]
-#+end_src
+```
-* =github_commits.py=
+# `github_commits.py`
-#+begin_src sh
+``` bash
python ./github_commits.py
-#+end_src
+```
-#+begin_src text
+``` text
Total commits in the repository 'demo-repository' on branch 'main': 3
Commit SHA: 13c488a2cdda08e4043f8ef36ced5fdd429e9718
@@ -109,4 +110,4 @@ Files changed:
Additions: 1, Deletions: 0, Changes: 1
- package.json (added)
Additions: 9, Deletions: 0, Changes: 9
-#+end_src
+```