Skip to content

Commit 9d48e71

Browse files
authored
🚣 [readme] update features in .just readme (#52)
1 parent 512e129 commit 9d48e71

File tree

1 file changed

+39
-6
lines changed

1 file changed

+39
-6
lines changed

.just/README.md

Lines changed: 39 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,35 @@ to see which of our repos need updates of the just files.
2323

2424
Core PR lifecycle management with these features:
2525

26+
#### Branch Management
27+
2628
- **Branch creation** - `just branch <name>` creates dated branches in `$USER/YYYY-MM-DD-<name>` format
27-
- **PR creation** - `just pr` creates PRs using first commit message as title, all commits in body
28-
- **PR checks monitoring** - Watches GitHub Actions checks with 5-second polling
29-
- **AI integration** - Displays GitHub Copilot and Claude Code review comments after checks complete
30-
- **PR merge** - `just merge` squash merges, deletes remote branch, returns to main, and pulls latest
3129
- **Branch escape** - `just sync` returns to main branch and pulls latest changes
30+
- **UTC date utility** - `just utcdate` prints UTC date in ISO format (used internally for branch names)
31+
32+
#### PR Creation and Updates
33+
34+
- **PR creation** - `just pr` creates PRs using first commit message as title, all commits in body
35+
- **PR description updates** - `just pr_update` regenerates the Done section with current commits while preserving other sections
36+
- **PR verification logs** - `just pr_verify` adds or appends timestamped content to a Verify section (reads from stdin)
37+
- **Iterative workflow** - `just again` chains push, PR update, and checks monitoring for rapid iteration
3238
- **Web viewing** - `just prweb` opens current PR in browser
33-
- **Releases** - `just release <version>` creates GitHub releases with auto-generated notes
34-
- **Sanity checks** - Hidden recipes (`_on_a_branch`, `_has_commits`, `_main_branch`) prevent mistakes
39+
40+
#### PR Checks and AI Reviews
41+
42+
- **PR checks monitoring** - `just pr_checks` watches GitHub Actions checks with 5-second polling
43+
- **AI integration** - Displays both GitHub Copilot and Claude Code review comments after checks complete
44+
- **Standalone Claude review** - `just claude_review` shows Claude's latest PR comment without re-running checks
45+
46+
#### Merge and Release
47+
48+
- **PR merge** - `just merge` squash merges, deletes remote branch, returns to main, and pulls latest
49+
- **Releases** - `just release <version>` creates GitHub releases with auto-generated notes and pulls the new tag locally
50+
- **Release monitoring** - `just release_age` checks how long ago the last release was published, warns if >60 days old
51+
52+
#### Safety and Automation
53+
54+
- **Sanity checks** - Hidden recipes (`_on_a_branch`, `_has_commits`, `_main_branch`, `_on_a_pull_request`) prevent mistakes
3555
- **Pre-PR hooks** - Optional integration with `pr-hook.just` for project-specific automation
3656

3757
### compliance.just - Repository Health Checks
@@ -74,3 +94,16 @@ Optional pre-PR automation hook:
7494
- **Placeholder implementation** - Currently just prints a message
7595
- **Customizable** - Replace with project-specific tasks (e.g., Hugo rebuilds, asset compilation)
7696
- **Hidden recipe** - Uses `_pr-hook` naming to indicate internal use only
97+
98+
### install-prerequisites.sh - Prerequisites Installation Helper
99+
100+
Standalone shell script that automates installation and verification of all required tools:
101+
102+
- **Automatic detection** - Checks for all required tools: `just`, `gh`, `shellcheck`, `markdownlint-cli2`, `jq`
103+
- **Smart installation** - On macOS with Homebrew, automatically installs missing tools
104+
- **Manual guidance** - On Linux, provides appropriate installation commands for apt-get, dnf, or pacman
105+
- **Clear reporting** - Shows what's already installed vs. what's missing with color-coded output
106+
- **Error handling** - Detects missing package managers, provides helpful error messages
107+
- **Verification mode** - Run multiple times to verify installations completed successfully
108+
109+
Run `./.just/install-prerequisites.sh` to check your environment or install missing tools. Makes onboarding new contributors significantly smoother.

0 commit comments

Comments
 (0)