Skip to content

Commit ca93b2c

Browse files
authored
🐡 [readme] initial .just/RELEASE_NOTES.md (#34)
* 🐡 [readme] initial .just/RELEASE_NOTES.md * cross-link related docs
1 parent 9ec0a30 commit ca93b2c

File tree

3 files changed

+128
-0
lines changed

3 files changed

+128
-0
lines changed

.just/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,6 @@ project for updates.
99

1010
We use the [repos-summary script](https://github.com/chicks-net/chicks-home/blob/main/bin/repos-summary)
1111
to see which of our repos need updates of the just files.
12+
13+
You can read our [release notes](RELEASE_NOTES.md) to learn more about
14+
the history of how we have evolved the github PR process.

.just/RELEASE_NOTES.md

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
# Release Notes: gh-process.just
2+
3+
This file tracks the evolution of the Git/GitHub workflow automation module.
4+
5+
## Planned Changes
6+
7+
- Remove requirement to use
8+
[my git aliases](https://github.com/chicks-net/chicks-home/blob/main/.gitconfig)
9+
for this to work by expanding all of the `git` commands to
10+
work on stock `git` installs.
11+
12+
## November 2025 - The Polish Update
13+
14+
### v3.7 - Pre-PR Hook Support (#32, #33)
15+
16+
Added support for optional pre-PR hooks to allow project-specific automation
17+
before creating pull requests. The `pr` recipe now checks for
18+
`.just/pr-hook.just` and runs it if present. This is particularly useful for
19+
projects that need to rebuild assets (like Hugo sites) before pushing.
20+
21+
- Added conditional hook execution in PR workflow
22+
- Hidden `_pr-hook` recipe (internal use)
23+
- Updated documentation with workflow versioning
24+
25+
**Related PRs:** [#32](https://github.com/fini-net/template-repo/pull/32), [#33](https://github.com/fini-net/template-repo/pull/33)
26+
27+
### v3.6 - Quote Consistency (#31)
28+
29+
Improved shell script robustness with more consistent quoting of variables and
30+
just template parameters. Small change, but makes the scripts more reliable
31+
when dealing with branch names or paths that might contain spaces.
32+
33+
**Related PRs:** [#31](https://github.com/fini-net/template-repo/pull/31)
34+
35+
### v3.5 - Spacing and Multi-Commit Handling (#30)
36+
37+
Cleaned up the codebase and improved handling of branches with multiple commits:
38+
39+
- Better formatting and spacing throughout
40+
- Cleaned up vestigial variables from earlier iterations
41+
- Improved quoting of just variables
42+
- More consistent handling of multiple commits on a branch
43+
44+
**Related PRs:** [#30](https://github.com/fini-net/template-repo/pull/30)
45+
46+
## October 2025 - The AI Review Update
47+
48+
### v3.4 - Graceful Failure Handling (#26)
49+
50+
Fixed an issue where broken GitHub Actions would prevent the review comments
51+
from being displayed. The workflow now continues to show AI reviews even if
52+
some checks fail, because you probably want to see those reviews even more when
53+
things are broken.
54+
55+
**Related PRs:** [#26](https://github.com/fini-net/template-repo/pull/26)
56+
57+
### v3.3 - Copilot and Claude Review Integration (#25)
58+
59+
This was a big one. After PR checks complete, the workflow now automatically
60+
fetches and displays comments from both GitHub Copilot and Claude Code reviews
61+
right in your terminal. No more switching to the browser to see what the bots
62+
think.
63+
64+
- Added GraphQL query to fetch Copilot PR review comments
65+
- Displays Copilot suggestions after PR checks complete
66+
- Shows Claude's most recent comment
67+
- Uses `jq` to parse and filter review data
68+
69+
**Related PRs:** [#25](https://github.com/fini-net/template-repo/pull/25)
70+
71+
## August 2025 - The Safety Update
72+
73+
### v3.2 - Commit Verification (#21)
74+
75+
Added a sanity check to prevent accidentally creating empty PRs. The `pr` recipe now verifies that your branch actually has commits before allowing you to create a pull request. Uses `git cherry` to compare against the release branch.
76+
77+
- New `_has_commits` dependency check
78+
- Clear error message when branch is empty
79+
- Exit code 101 for tracking
80+
81+
**Related PRs:** [#21](https://github.com/fini-net/template-repo/pull/21)
82+
83+
### Faster PR Check Monitoring (#20)
84+
85+
Changed the PR checks watcher to poll every 5 seconds instead of the default. Because who wants to wait around? GitHub's API might be lazy, but we don't have to be.
86+
87+
**Related PRs:** [#20](https://github.com/fini-net/template-repo/pull/20)
88+
89+
## June 2025 - The Beginning of this file
90+
91+
### v3.1 - Initial Release (#11)
92+
93+
Created as part of a larger refactoring effort to modularize the main justfile.
94+
This file extracted all the Git/GitHub workflow automation into a separate
95+
module.
96+
97+
Core recipes included from day one:
98+
99+
- `sync` - Return to main and pull latest
100+
- `pr` - Create PR from current branch
101+
- `merge` - Squash merge and clean up
102+
- `branch` - Create dated feature branches
103+
- `prweb` - Open PR in browser
104+
- `release` - Create GitHub releases
105+
- `pr_checks` - Watch PR checks (later enhanced)
106+
107+
Plus a bunch of sanity check helpers (`_on_a_branch`, `_main_branch`, etc.) to
108+
keep you from footgunning yourself.
109+
110+
**Related PRs:** [#11](https://github.com/fini-net/template-repo/pull/11)
111+
112+
---
113+
114+
## Pre-history
115+
116+
Earlier versions of this code came from the `/justfile` in
117+
[this repo](https://github.com/fini-net/template-repo/blob/main/justfile)
118+
and some of my other repos, primarily
119+
[www-chicks-net](https://github.com/chicks-net/www-chicks-net/blob/main/justfile).
120+
It all started [very simply](https://github.com/chicks-net/www-chicks-net/commit/06f28b13d82e445951b10af1a57488a1dc9e1069).
121+
122+
I think there were some 2.x versions, but I haven't found them again.

.just/gh-process.just

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# git/gh process justfile
22

3+
# check out the RELEASE_NOTES.md for the detailed history of this file
4+
# the README.md in this directory also might be useful to you
5+
36
# some useful variables
47
release_branch := "main"
58

0 commit comments

Comments
 (0)