Skip to content

Commit d21d36e

Browse files
bscottbscott
authored
Merge pull request #91 from bscott/v0.5.4
v0.5.4 - Documentation Updates
2 parents 3a89057 + 18779eb commit d21d36e

File tree

5 files changed

+270
-22
lines changed

5 files changed

+270
-22
lines changed

‎.github/workflows/claude-code-review.yml‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: Claude Code Review
2+
3+
on:
4+
pull_request:
5+
types: [opened, synchronize, ready_for_review, reopened]
6+
# Optional: Only run on specific file changes
7+
# paths:
8+
# - "src/**/*.ts"
9+
# - "src/**/*.tsx"
10+
# - "src/**/*.js"
11+
# - "src/**/*.jsx"
12+
13+
jobs:
14+
claude-review:
15+
# Optional: Filter by PR author
16+
# if: |
17+
# github.event.pull_request.user.login == 'external-contributor' ||
18+
# github.event.pull_request.user.login == 'new-developer' ||
19+
# github.event.pull_request.author_association == 'FIRST_TIME_CONTRIBUTOR'
20+
21+
runs-on: ubuntu-latest
22+
permissions:
23+
contents: read
24+
pull-requests: read
25+
issues: read
26+
id-token: write
27+
28+
steps:
29+
- name: Checkout repository
30+
uses: actions/checkout@v4
31+
with:
32+
fetch-depth: 1
33+
34+
- name: Run Claude Code Review
35+
id: claude-review
36+
uses: anthropics/claude-code-action@v1
37+
with:
38+
claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
39+
plugin_marketplaces: 'https://github.com/anthropics/claude-code.git'
40+
plugins: 'code-review@claude-code-plugins'
41+
prompt: '/code-review:code-review ${{ github.repository }}/pull/${{ github.event.pull_request.number }}'
42+
# See https://github.com/anthropics/claude-code-action/blob/main/docs/usage.md
43+
# or https://code.claude.com/docs/en/cli-reference for available options
44+

‎.github/workflows/claude.yml‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Claude Code
2+
3+
on:
4+
issue_comment:
5+
types: [created]
6+
pull_request_review_comment:
7+
types: [created]
8+
issues:
9+
types: [opened, assigned]
10+
pull_request_review:
11+
types: [submitted]
12+
13+
jobs:
14+
claude:
15+
if: |
16+
(github.event_name == 'issue_comment' && contains(github.event.comment.body, '@claude')) ||
17+
(github.event_name == 'pull_request_review_comment' && contains(github.event.comment.body, '@claude')) ||
18+
(github.event_name == 'pull_request_review' && contains(github.event.review.body, '@claude')) ||
19+
(github.event_name == 'issues' && (contains(github.event.issue.body, '@claude') || contains(github.event.issue.title, '@claude')))
20+
runs-on: ubuntu-latest
21+
permissions:
22+
contents: read
23+
pull-requests: read
24+
issues: read
25+
id-token: write
26+
actions: read # Required for Claude to read CI results on PRs
27+
steps:
28+
- name: Checkout repository
29+
uses: actions/checkout@v4
30+
with:
31+
fetch-depth: 1
32+
33+
- name: Run Claude Code
34+
id: claude
35+
uses: anthropics/claude-code-action@v1
36+
with:
37+
claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
38+
39+
# This is an optional setting that allows Claude to read CI results on PRs
40+
additional_permissions: |
41+
actions: read
42+
43+
# Optional: Give a custom prompt to Claude. If this is not specified, Claude will perform the instructions specified in the comment that tagged it.
44+
# prompt: 'Update the pull request description to include a summary of changes.'
45+
46+
# Optional: Add claude_args to customize behavior and configuration
47+
# See https://github.com/anthropics/claude-code-action/blob/main/docs/usage.md
48+
# or https://code.claude.com/docs/en/cli-reference for available options
49+
# claude_args: '--allowed-tools Bash(gh pr:*)'
50+

‎.gitignore‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,13 @@
77
subtrackr
88
main
99

10-
# Beads
10+
# Beads (keep issues.jsonl and interactions.jsonl for syncing)
1111
.beads/beads.db
12+
.beads/config.yaml
13+
.beads/metadata.json
14+
.beads/README.md
15+
.beads/.gitignore
16+
.beads/export-state/
1217

1318
# Test binary, built with `go test -c`
1419
*.test

‎AGENTS.md‎

Lines changed: 33 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -166,27 +166,39 @@ subtrackr-xyz/
166166
- Dark mode support via class-based switching
167167
- Mobile-responsive design
168168

169-
### Recent Changes (v0.4.5)
170-
171-
#### PR #51 - SMTP TLS/SSL Support
172-
- Added STARTTLS support for standard SMTP ports
173-
- Added implicit TLS support for SSL ports (465, 8465, 443)
174-
- Improved error messages for SSL vs STARTTLS failures
175-
- Added loading spinner to test connection button
176-
- Fixed authentication failures with SMTP2Go and similar providers
177-
178-
### Open Issues for v0.4.5
179-
180-
1. **#50** - bug: cannot use SMTP2GO as an SMTP server (RESOLVED by PR #51)
181-
2. **#52** - Add Quarterly schedule option (enhancement)
182-
3. **#49** - feature request: add more type of schedule (enhancement)
183-
4. **#48** - bug: some elements in settings are white even in dark mode (bug)
184-
5. **#47** - [FR] Docker Healthcheck (enhancement)
185-
6. **#41** - How to handle bi-annual and odd subscription renewal schedules? (enhancement)
186-
7. **#39** - Mobile view improvement (enhancement)
187-
8. **#37** - Improve date parsing in subscription handlers (enhancement)
188-
9. **#29** - bug/feat?: Auto update "Next renewal date" after date passes (enhancement)
189-
10. **#27** - feat: Sorting on /subscriptions table (enhancement)
169+
### Recent Changes
170+
171+
#### v0.5.3 - Sort Persistence and PWA Support
172+
- Remember sorting preference (#85) - localStorage persistence
173+
- Fix Tab and PWA icon missing (#84) - favicon, apple-touch-icon, manifest.json
174+
- Input validation for sort parameters
175+
- PWA meta tags on all HTML templates
176+
177+
#### v0.5.2 - Currency Improvements
178+
- Enhanced currency support and conversion display
179+
180+
#### v0.5.1 - Dark Classic Theme and Calendar Fixes
181+
- Dark classic theme option
182+
- Calendar view improvements
183+
184+
#### v0.5.0 - Optional Login Support
185+
- Optional authentication system
186+
- Beautiful theme options
187+
188+
### Release Workflow
189+
190+
This project uses versioned branches for releases. See `CLAUDE.md` for the complete workflow.
191+
192+
**Quick Reference:**
193+
1. Create versioned branch: `git checkout -b vX.Y.Z`
194+
2. Track work with beads: `bd create`, `bd update`, `bd close`
195+
3. Create draft release: `gh release create vX.Y.Z --draft`
196+
4. Run code review agent before committing
197+
5. Commit, push, create PR: `gh pr create`
198+
6. Comment on GitHub issues: `gh issue comment`
199+
7. Monitor CI: `gh run watch`
200+
8. Merge PR: `gh pr merge --merge --delete-branch`
201+
9. Publish release: `gh release edit vX.Y.Z --draft=false`
190202

191203
### Common Tasks
192204

‎CLAUDE.md‎

Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
# SubTrackr - Claude Code Instructions
2+
3+
## Release Workflow
4+
5+
This project uses versioned branches for releases. Follow this workflow when working on new features or bug fixes.
6+
7+
### 1. Create a Versioned Branch
8+
9+
```bash
10+
# Check current version
11+
gh release list --limit 1
12+
13+
# Create and checkout versioned branch
14+
git checkout -b v0.X.Y
15+
```
16+
17+
### 2. Track Work with Beads
18+
19+
```bash
20+
# Create beads issues for work items
21+
bd create --title="Feature description (#GitHub-issue)" --type=feature --priority=2
22+
23+
# Update status when starting work
24+
bd update <issue-id> --status=in_progress
25+
26+
# Close when complete
27+
bd close <issue-id> --reason="Implemented in vX.Y.Z"
28+
```
29+
30+
### 3. Create Draft Release Before Committing
31+
32+
```bash
33+
# Create draft release with release notes
34+
gh release create vX.Y.Z --draft --title "vX.Y.Z - Release Title" --notes "$(cat <<'EOF'
35+
## What's New
36+
37+
### Feature Name (#issue)
38+
- Description of changes
39+
40+
## Technical Changes
41+
- List of technical changes
42+
EOF
43+
)"
44+
```
45+
46+
### 4. Code Review
47+
48+
Before committing, run the code review agent:
49+
- Check for code quality issues
50+
- Verify security concerns
51+
- Ensure best practices
52+
53+
### 5. Commit and Push
54+
55+
```bash
56+
# Stage changes
57+
git add <files>
58+
59+
# Commit with descriptive message
60+
git commit -m "vX.Y.Z - Release Title
61+
62+
- Change 1
63+
- Change 2"
64+
65+
# Push branch
66+
git push -u origin vX.Y.Z
67+
```
68+
69+
### 6. Create Pull Request
70+
71+
```bash
72+
gh pr create --title "vX.Y.Z - Release Title" --body "$(cat <<'EOF'
73+
## Summary
74+
- Change summary
75+
76+
## Test Plan
77+
- [ ] Test item 1
78+
- [ ] Test item 2
79+
80+
Closes #issue1
81+
Closes #issue2
82+
EOF
83+
)"
84+
```
85+
86+
### 7. Comment on GitHub Issues
87+
88+
```bash
89+
# Notify issue reporters
90+
gh issue comment <issue-number> --body "Fixed in PR #XX. Description of fix."
91+
```
92+
93+
### 8. Monitor CI and Merge
94+
95+
```bash
96+
# Watch GitHub Actions
97+
gh run watch <run-id> --exit-status
98+
99+
# Merge when CI passes
100+
gh pr merge <pr-number> --merge --delete-branch
101+
102+
# Switch to main
103+
git checkout main && git pull
104+
```
105+
106+
### 9. Publish Release
107+
108+
```bash
109+
# Publish the draft release
110+
gh release edit vX.Y.Z --draft=false
111+
112+
# Verify
113+
gh release view vX.Y.Z
114+
```
115+
116+
## Beads Integration
117+
118+
This project uses beads for local issue tracking across sessions.
119+
120+
### Files
121+
- `.beads/issues.jsonl` - Issue data (committed)
122+
- `.beads/interactions.jsonl` - Audit log (committed)
123+
- `.beads/beads.db` - Local cache (gitignored)
124+
125+
### Commands
126+
- `bd ready` - Find available work
127+
- `bd create` - Create new issue
128+
- `bd update` - Update issue status
129+
- `bd close` - Close completed issues
130+
- `bd sync --from-main` - Sync from main branch
131+
132+
## Git Commit Guidelines
133+
134+
- Do not include AI attribution in commit messages
135+
- Use conventional commit format
136+
- Keep messages clear and descriptive
137+
- Reference GitHub issue numbers where applicable

0 commit comments

Comments
 (0)