diff options
Diffstat (limited to 'applications')
| -rw-r--r-- | applications/github/README.md (renamed from applications/github/README.org) | 65 | ||||
| -rw-r--r-- | applications/gitlab/README.md (renamed from applications/gitlab/README.org) | 79 |
2 files changed, 72 insertions, 72 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 +``` diff --git a/applications/gitlab/README.org b/applications/gitlab/README.md index d137497..a564f13 100644 --- a/applications/gitlab/README.org +++ b/applications/gitlab/README.md @@ -1,14 +1,12 @@ -#+title: GitLab Scripts +# `approvals.py` -* =approvals.py= +\\This script requires an active Premium or Ultimate subscription.\*\\ -\*This script requires an active Premium or Ultimate subscription.*\ - -#+begin_src sh +``` bash python ./approvals.py -#+end_src +``` -#+begin_src text +``` text Rule: All Members Approvals Required: 1 Rule type: any_approver @@ -17,15 +15,15 @@ Rule: Default Rule type: regular Protected Branch: master Eligible Approver: Christian Cleberg -#+end_src +``` -* =branch_protections.py= +# `branch_protections.py` -#+begin_src sh +``` bash python ./branch_protections.py -#+end_src +``` -#+begin_src json +``` json [ { "id": 148448212, @@ -55,27 +53,28 @@ python ./branch_protections.py "inherited": false } ] -#+end_src +``` -* =passwords.py= +# `passwords.py` -*This script does not apply to GitLab.com. This is for self-hosted instances only.* +**This script does not apply to GitLab.com. This is for self-hosted +instances only.** -#+begin_src sh +``` bash python ./passwords.py -#+end_src +``` -#+begin_src text +``` text # TODO: Need access to a self-hosted version of GitLab to test this out. -#+end_src +``` -* =pipelines.py= +# `pipelines.py` -#+begin_src sh +``` bash python ./pipelines.py -#+end_src +``` -#+begin_src text +``` text Pipeline ID: 1754222228 Status: failed Ref: master @@ -100,28 +99,28 @@ Pipeline ID: 1754214637 Created At: 2025-04-06T03:21:39.902Z Duration: N/A seconds Configuration: N/A -#+end_src +``` -* =provisioning.py= +# `provisioning.py` -\*This script requires an active Premium or Ultimate subscription.*\ +\\This script requires an active Premium or Ultimate subscription.\*\\ -#+begin_src sh +``` bash python ./provisioning.py -#+end_src +``` -#+begin_src text +``` text Group: 105300140 2025-04-08T03:33:17.055Z : Action: member_created, Member: 128029250, Author: 24608590 -#+end_src +``` -* =repositories.py= +# `repositories.py` -#+begin_src shell +``` shell python ./repositories.py -#+end_src +``` -#+begin_src text +``` text # User ID Example Projects under ID: ccleberg: - audit-tools (ID: 68757698) @@ -131,15 +130,15 @@ Projects under ID: ccleberg: Projects under ID: phryq: - Yoshi Cli (ID: 68757750) - pages-demo (ID: 68757186) -#+end_src +``` -* =users.py= +# `users.py` -#+begin_src sh +``` bash python ./users.py -#+end_src +``` -#+begin_src text +``` text Access Level Roles: 0 : No access 5 : Minimal access @@ -158,4 +157,4 @@ Username: ccleberg, Access Level: 50 Project 68701468 Members: Username: ccleberg, Access Level: 50 Username: project_68701468_bot_2c7ee010a479c0e48cdb4c7c5cfae886, Access Level: 40 -#+end_src +``` |