Skip to content

Commit 5d0a28f

Browse files
committed
wip
1 parent 8cc2fc7 commit 5d0a28f

28 files changed

+472
-472
lines changed

.claude/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ export GITHUB_TOKEN="ghp_..." # Set GitHub token
5656

5757
### 2. Sync GitHub Data
5858
```bash
59-
release-tool sync # Sync issues, PRs, releases
59+
release-tool pull # Sync issues, PRs, releases
6060
```
6161

6262
### 3. Generate Release Notes
@@ -138,7 +138,7 @@ See `.claude/commands/` for custom slash commands:
138138
## Important Files
139139

140140
- `release_tool.toml` - Configuration file (created by `init-config`)
141-
- `release_tool.db` - SQLite cache (auto-created by `sync`)
141+
- `release_tool.db` - SQLite cache (auto-created by `pull`)
142142
- `.release_tool_cache/` - Cloned git repositories for offline access
143143
- `docs/` - User documentation
144144
- `tests/` - Comprehensive unit tests

.release_tool.toml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,9 @@ api_url = "https://api.github.com"
5454
path = "release_tool.db"
5555

5656
# =============================================================================
57-
# Sync Configuration
57+
# Pull Configuration
5858
# =============================================================================
59-
[sync]
59+
[pull]
6060
# cutoff_date: Only fetch issues/PRs created after this date (ISO format: YYYY-MM-DD)
6161
# This limits historical data fetching and speeds up initial sync
6262
# Example: "2024-01-01" to only fetch data from 2024 onwards
@@ -80,8 +80,8 @@ clone_code_repo = true
8080
# Default: null (uses .release_tool_cache/{repo_name})
8181
# code_repo_path = "/path/to/local/repo"
8282

83-
# show_progress: Show progress updates during sync
84-
# When true, displays messages like "syncing 13 / 156 issues (10% done)"
83+
# show_progress: Show progress updates during pull
84+
# When true, displays messages like "pulling 13 / 156 issues (10% done)"
8585
# Default: true
8686
show_progress = true
8787

@@ -158,7 +158,7 @@ unclosed_issue_action = "warn"
158158
#
159159
# "Partial matches" occur when:
160160
# - Issue key extracted from branch/PR, but issue not in database (common causes):
161-
# * Issue created before your sync cutoff date
161+
# * Issue created before your pull cutoff date
162162
# * Issue doesn't exist (typo in branch name)
163163
# * Sync hasn't been run yet
164164
# - Issue found in database, but in wrong repository:

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ jobs:
8484
env:
8585
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
8686
run: |
87-
release-tool sync
87+
release-tool pull
8888
release-tool generate ${{ github.event.inputs.version }} --upload
8989
```
9090
@@ -93,7 +93,7 @@ jobs:
9393
If you need to use SSH (e.g., for private repos without token access), configure your `release_tool.toml`:
9494

9595
```toml
96-
[sync]
96+
[pull]
9797
clone_method = "ssh" # Options: "https", "ssh", "auto" (default)
9898
```
9999

@@ -109,7 +109,7 @@ Then set up SSH keys in your workflow:
109109
env:
110110
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Still needed for API calls
111111
run: |
112-
release-tool sync
112+
release-tool pull
113113
release-tool generate ${{ github.event.inputs.version }}
114114
```
115115

@@ -129,7 +129,7 @@ For GitHub Enterprise or custom Git servers:
129129
[github]
130130
api_url = "https://github.enterprise.com/api/v3"
131131
132-
[sync]
132+
[pull]
133133
clone_url_template = "https://github.enterprise.com/{repo_full_name}.git"
134134
```
135135

@@ -167,9 +167,9 @@ If you encounter clone errors:
167167
export GITHUB_TOKEN="your_github_token"
168168
```
169169

170-
4. **Sync repository data**:
170+
4. **Pull repository data**:
171171
```bash
172-
release-tool sync
172+
release-tool pull
173173
```
174174

175175
5. **Generate release notes**:
@@ -179,10 +179,10 @@ If you encounter clone errors:
179179

180180
## CLI Commands
181181

182-
### `sync`
183-
Sync repository data from GitHub to the local database:
182+
### `pull`
183+
Pull repository data from GitHub to the local database:
184184
```bash
185-
release-tool sync [repository] [--repo-path PATH]
185+
release-tool pull [repository] [--repo-path PATH]
186186
```
187187

188188
### `generate`
@@ -226,9 +226,9 @@ issue_repo = "owner/issues" # Optional: separate repo for issues
226226
default_branch = "main"
227227
```
228228

229-
### Sync Configuration
229+
### Pull Configuration
230230
```toml
231-
[sync]
231+
[pull]
232232
clone_code_repo = true # Whether to clone the repository locally
233233
clone_method = "auto" # Options: "https", "ssh", "auto" (default)
234234
clone_url_template = "" # Custom clone URL template (optional)
@@ -364,7 +364,7 @@ export GITHUB_TOKEN="ghp_your_token"
364364
# 2. Edit release_tool.toml with your repo settings
365365

366366
# 3. Sync GitHub data once or periodically
367-
release-tool sync
367+
release-tool pull
368368

369369
# 4. Generate release notes for version 2.0.0
370370
release-tool generate 2.0.0 \

docs/doc/branching-strategy.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,9 +154,9 @@ $ release-tool generate 9.0.5 --repo-path .
154154
# Run tests, build, etc.
155155
```
156156

157-
4. **Publish Release**
157+
4. **Push Release**
158158
```bash
159-
release-tool publish 9.1.0 -f notes.md
159+
release-tool push 9.1.0 -f notes.md
160160
```
161161

162162
## Custom Branch Templates

docs/doc/configuration.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ Sensitive information like tokens should be set via environment variables:
7373
- `token`: (Optional) GitHub Personal Access Token. Recommended to use `GITHUB_TOKEN` environment variable instead.
7474
- `api_url`: (Optional) GitHub API URL. Default is `https://api.github.com`. Use for GitHub Enterprise.
7575

76-
### `sync`
76+
### `pull`
7777

7878
Configuration for syncing data from GitHub.
7979

@@ -96,7 +96,7 @@ Configuration for syncing data from GitHub.
9696
- **Default**: `"auto"`
9797
- **Example**:
9898
```toml
99-
[sync]
99+
[pull]
100100
clone_method = "https" # For GitHub Actions
101101
```
102102

@@ -105,7 +105,7 @@ Configuration for syncing data from GitHub.
105105
- **Description**: Custom clone URL template for GitHub Enterprise or custom Git servers. Use `{repo_full_name}` as placeholder.
106106
- **Example**:
107107
```toml
108-
[sync]
108+
[pull]
109109
clone_url_template = "https://github.enterprise.com/{repo_full_name}.git"
110110
```
111111

docs/doc/development.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Standard unit tests covering:
5050
- Policies and business logic (`test_policies.py`)
5151
- Template rendering (`test_output_template.py`, `test_default_template.py`)
5252
- Issue management (`test_query_issues.py`, `test_partial_issues.py`)
53-
- Publishing and syncing (`test_publish.py`, `test_sync.py`)
53+
- Pushing and syncing (`test_push.py`, `test_pull.py`)
5454

5555
```bash
5656
# Run all unit tests except Docker tests

docs/doc/intro.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ The **Release Tool** is a CLI application designed to manage releases using sema
1818
- **Semantic Versioning**: Automatically determines the next version based on changes.
1919
- **Release Notes Generation**: Groups and formats release notes from Pull Requests and issues.
2020
- **Policy-Driven**: Highly configurable policies for versioning, issue extraction, and grouping.
21-
- **GitHub Integration**: Syncs data from GitHub and creates releases.
22-
- **GitHub Actions Bot**: Automate releases with ChatOps and auto-publishing ([Release Bot](release-bot.md)).
23-
- **Multiple Release Modes**: Draft, published, and just-publish modes for different workflows.
21+
- **GitHub Integration**: Pulls data from GitHub and creates releases.
22+
- **GitHub Actions Bot**: Automate releases with ChatOps and auto-pushing ([Release Bot](release-bot.md)).
23+
- **Multiple Release Modes**: Draft, published, and just-push modes for different workflows.
2424
- **SQLite Storage**: Caches repository data locally for efficiency.
2525

2626
## Goals

docs/doc/issues.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The `issues` command allows you to search and inspect issues that have been sync
2424
- **Offline access** - Query issues without internet connectivity
2525

2626
:::caution Prerequisites
27-
This command only searches issues that have been synced. Make sure to run `release-tool sync` first to populate your local database.
27+
This command only searches issues that have been synced. Make sure to run `release-tool pull` first to populate your local database.
2828
:::
2929

3030
## Smart ISSUE_KEY Format
@@ -256,7 +256,7 @@ If you see:
256256
257257
Issues not found in database (1):
258258
• 8853 (from branch feat/meta-8853/main, PR #2122)
259-
→ Issue may be older than sync cutoff date
259+
→ Issue may be older than pull cutoff date
260260
→ Issue may not exist (typo in branch/PR)
261261
→ Sync may not have been run yet
262262
```
@@ -280,7 +280,7 @@ Issues not found in database (1):
280280

281281
4. If not found, verify on GitHub or re-run sync:
282282
```bash
283-
release-tool sync
283+
release-tool pull
284284
```
285285

286286
### Scenario 2: Issue in Different Repo
@@ -418,7 +418,7 @@ Since results are sorted by `created_at DESC`, the first results show the newest
418418
release-tool issues --limit 10
419419
```
420420

421-
### 5. Verify Sync Coverage
421+
### 5. Verify Pull Coverage
422422

423423
Check if issues from a specific time period are synced:
424424

@@ -435,36 +435,36 @@ release-tool issues --limit 1000 --format csv > all_issues.csv
435435

436436
**Error:**
437437
```
438-
Error: Database not found. Please run 'release-tool sync' first.
438+
Error: Database not found. Please run 'release-tool pull' first.
439439
```
440440

441441
**Solution:**
442442
```bash
443-
release-tool sync
443+
release-tool pull
444444
```
445445

446-
The database is created by the `sync` command. If you've never synced, the database doesn't exist yet.
446+
The database is created by the `pull` command. If you've never synced, the database doesn't exist yet.
447447

448448
### "Repository 'X' not found in database"
449449

450450
**Error:**
451451
```
452452
Error: Repository 'sequentech/unknown' not found in database.
453-
Tip: Run 'release-tool sync' to fetch repository data.
453+
Tip: Run 'release-tool pull' to fetch repository data.
454454
```
455455

456456
**Solutions:**
457457
1. Check the repository name spelling
458458
2. Ensure the repository is configured in `release_tool.toml`
459-
3. Run `release-tool sync` to fetch repository metadata
459+
3. Run `release-tool pull` to fetch repository metadata
460460

461461
### No Results Found
462462

463463
If your query returns no results:
464464

465465
1. Verify issues exist on GitHub
466-
2. Check your sync cutoff date (might be excluding old issues)
467-
3. Re-run sync: `release-tool sync`
466+
2. Check your pull cutoff date (might be excluding old issues)
467+
3. Re-run sync: `release-tool pull`
468468
4. Try fuzzy matching instead of exact match
469469

470470
### CSV Output Looks Wrong in Terminal

0 commit comments

Comments
 (0)