Skip to content

Commit 170c6b1

Browse files
CompEng0001CompEng0001
committed
mod: update readme based on be4791c, f004091, 7ee04b8 
1 parent be4791c commit 170c6b1

File tree

1 file changed

+77
-22
lines changed

1 file changed

+77
-22
lines changed

‎README.md

Lines changed: 77 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -36,27 +36,77 @@ Checks the current running/ran workflow, I mainly use this for checking the depl
3636
**Output:**
3737
3838
```
39-
Checking the last executed run in git@github.com:USER/REPO repository's workflow:
40-
Workflow: deploy to github pages | state: queued
39+
$git_workflows
40+
Info: Checking the last executed run in git@github.com:USER/REPO...
4141
Workflow: pages build and deployment | state: waiting
4242
Workflow: pages build and deployment | state: completed
43-
Workflow: deploy to github pages | state: completed
44-
Workflow conclusion: success | Time: 15s | DT: 2024-07-24 10:55:40 +00:00
45-
API Rate Limit remaining: 4994
43+
Success: Workflow conclusion: success | Duration: 27s | Completed at: 2024-12-16 17:30:31 +00:00
44+
Info: GitHub API rate limit remaining: 4976
45+
Checking the last executed run in git@github.com:USER/REPO repository's workflow:
46+
Workflow: deploy to github pages | state: queued
47+
```
48+
4649
```
4750
4851
## git_better_branch
4952
5053
Checks current status of branches in repo, based off of the [better-branch.sh](https://gist.github.com/schacon/e9e743dee2e92db9a464619b99e94eff) script by [schacon](https://gist.github.com/schacon/).
5154
55+
```
56+
$git_better-branch --help
57+
A better way to see your Git branches across projects
58+
59+
Usage: git_better-branch.exe [OPTIONS]
60+
61+
Options:
62+
-d, --depth <DEPTH> Sets the maximum directory depth to search
63+
--all Show all branches (local and remote)
64+
--remote Show only remote branches
65+
--branch <BRANCH> Use this branch as the comparison base
66+
-h, --help Print help
67+
```
68+
5269
**Output:**
5370
5471
```
55-
Repo: git@github.com:USER/REPO
56-
Ahead Behind Branch Last Commit
57-
----- ------ ------------------------------ -------------------
58-
13 0 main 7 weeks ago
59-
0 0 dev 4 months ago
72+
gitCheck --all
73+
Repo: git@github.com:someuser/someuserepo
74+
Comparing against: main
75+
Ahead Behind Branch Last Commit
76+
----- ------ ------------------------------------------------------ -----------
77+
0 0 main 6 days ago
78+
0 0 origin 6 days ago
79+
0 0 origin/main 6 days ago
80+
0 22 origin/develop 6 days ago
81+
0 23 origin/feature/US0038-accounts-styling-resolutions-fix 6 days ago
82+
0 28 origin/feature/US0037-Transactions-Pie-Chart 7 days ago
83+
0 79 origin/feature/US0036-dashboard-syling 7 days ago
84+
0 54 origin/doc/ReadMe2 8 days ago
85+
0 51 origin/hc5167i-patch-1 9 days ago
86+
0 370 origin/doc/sprint-documents 9 days ago
87+
0 82 origin/feature/U0036-Adjusting-GCP-Database 9 days ago
88+
0 85 origin/US0036/feature-fix 9 days ago
89+
0 88 origin/feature/US0035-GCP-Revert 9 days ago
90+
1 170 origin/feature/US0028-budgeting-page-styling 9 days ago
91+
24 568 origin/gh-pages 9 days ago
92+
8 157 origin/doc/ReadMe 10 days ago
93+
0 124 origin/feature/US0034-GCP-Connection 3 weeks ago
94+
0 174 origin/feature/US0032-gh-pages 4 weeks ago
95+
0 439 origin/doc/stand-up-documents 4 weeks ago
96+
0 188 origin/feature/US0032-styling-updates 5 weeks ago
97+
2 220 origin/feature/US0028-Budgeting-Frontend 5 weeks ago
98+
0 189 origin/testing/QA-Testing-2 5 weeks ago
99+
0 202 origin/feature/US0030-Dashboard-Functionality 6 weeks ago
100+
0 204 origin/bug/US0031-Password-Verification-Fix 6 weeks ago
101+
0 210 origin/feature/US0027-accounts-page-styling 6 weeks ago
102+
0 212 origin/feature/US0029-QA-Fixes 6 weeks ago
103+
0 419 origin/doc/requirements 6 weeks ago
104+
0 234 origin/feature/US0023-transactions-page-styling 6 weeks ago
105+
0 234 origin/feature/US0024-transactions-page-styling 6 weeks ago
106+
0 234 origin/feature/US0025-Accounts-Backend 7 weeks ago
107+
0 242 origin/feature/US0023-Transactions-Jar-Link 7 weeks ago
108+
0 281 origin/feature/US0022-Styling-Fixes-Opening-Pages 7 weeks ago
109+
0 291 origin/qa/user_test_home_login 8 weeks ago
60110
```
61111
62112
## git_stats
@@ -71,27 +121,32 @@ Analyze Git commit contributions per author
71121
Usage: git_stats.exe [OPTIONS]
72122
73123
Options:
74-
--author <AUTHOR> Filter results by a specific author name (case-insensitive)
75-
--all Include all users (e.g., GitHub, bots) in the results
76-
--merge Include merge commits in the analysis
77-
--branch <BRANCH> Git branch to analyze. Defaults to the current branch if not specified
78-
--exclude [<GLOB>...] Inline glob patterns used to exclude files or directories
79-
--exclude-from-file <FILE> Path to a file containing additional exclude patterns (one per line)
80-
-h, --help Print help
124+
--author <AUTHOR> Filter results by a specific author name (case-insensitive)
125+
--all Include all users (e.g., GitHub, bots) in the results
126+
--merge Include merge commits in the analysis
127+
--branch <BRANCH> Git branch to analyze. Defaults to the current branch if not specified
128+
--exclude [<GLOB>...] Inline glob patterns used to exclude files or directories
129+
--exclude-from-file <FILE> Path to a file containing additional exclude patterns (one per line)
130+
-h, --help Print help
81131
```
82132
83133
**Outputs:**
84134
85135
```
86136
$ git_stats --all
87137
138+
Processing commit 455/455
139+
Done processing 455 commits.
140+
88141
Author Commits Files Insertions Deletions Net Change Most Ext Least Ext
89-
github 5 6 71 1 70 md py
90-
author1 8 8 373 203 170 py md
91-
author2 2 3 69 1 68 md py
142+
author1 8 16 2036 350 1686 jsx md
143+
author2 10 14 787 240 547 md py
144+
author3 128 91 14654 10196 4458 css txt
145+
author4 24 66 4087 917 3170 jsx css
146+
author5 4 14 1199 123 1076 jsx py
92147
--------------------------------------------------------------------------------------------------
93-
Total 15 17 513 205 308 - -
94-
Avg 5.00 5.67 171.00 68.33 102.67 - -
148+
Total 174 201 22763 11826 10937 - -
149+
Avg 34.80 40.20 4552.60 2365.20 2187.40 - -
95150
96151
```
97152

0 commit comments

Comments
 (0)