SidneyZhang/QuiCommit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 3 Wiki Activity

chore(release): bump version to 0.5.0 and update changelog

Browse Source
This commit is contained in:
Sidney Zhang
2026-07-24 17:59:22 +08:00
parent 206bde0786
commit 349ff56299
4 changed files with 65 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@@ -63,7 +63,7 @@ quicommit commit
# Manual commit
quicommit commit --manual -t feat -m "add new feature"
# Stage all and commit
# Stage all and commit (skips .gitignore-matched files automatically)
quicommit commit -a
# Skip confirmation
@@ -72,16 +72,24 @@ quicommit commit --yes
# Use date-based commit message
quicommit commit --date
# Enable LLM thinking/reasoning mode for this commit
quicommit commit --think
# Push after committing
quicommit commit --push
```
When staging changes (auto-stage or `--all`), files matched by `.gitignore` rules are skipped and any ignored files already in the index are removed; the skipped list is printed for review.
### Create Tag
```bash
# Auto-detect version bump
quicommit tag
# Auto-detect version from Cargo.toml/pyproject.toml, fall back to commit analysis
quicommit tag --auto
# Specify bump type
quicommit tag --bump minor
@@ -98,11 +106,14 @@ quicommit tag --push
### Generate Changelog
```bash
# Generate for unreleased changes
# Generate for unreleased changes (auto-detects --from from the highest version in the existing changelog)
quicommit changelog
# Generate for specific version
quicommit changelog -v 1.0.0
quicommit changelog --version 1.0.0
# Generate from a specific tag
quicommit changelog --from v0.9.0
# AI-generate changelog
quicommit changelog --generate
@@ -222,7 +233,7 @@ quicommit profile token
```bash
# Configure Ollama (local)
quicommit config set-llm ollama
quicommit config set-llm ollama --url http://localhost:11434 --model llama2
quicommit config set-llm ollama --base-url http://localhost:11434 --model llama2
# Configure OpenAI
quicommit config set-llm openai
@@ -309,13 +320,14 @@ quicommit config reset --force
| `-b, --breaking` | Mark as breaking change |
| `-d, --date` | Use date-based commit message |
| `--manual` | Manual input, skip AI |
| `-a, --all` | Stage all changes |
| `-a, --all` | Stage all changes (skips `.gitignore`-matched files) |
| `-S, --sign` | GPG sign commit |
| `--amend` | Amend previous commit |
| `--dry-run` | Show without committing |
| `--conventional` | Use Conventional Commits format |
| `--commitlint` | Use commitlint format |
| `--no-verify` | Skip commit message verification |
| `-t, --think` | Enable LLM thinking/reasoning mode (overrides config) |
| `-y, --yes` | Skip confirmation |
| `--push` | Push after committing |
| `--remote` | Specify remote repository (default: origin) |
@@ -326,6 +338,7 @@ quicommit config reset --force
|--------|-------------|
| `-n, --name` | Tag name |
| `-b, --bump` | Version bump (major/minor/patch) |
| `-A, --auto` | Auto-detect version from Cargo.toml/pyproject.toml, fall back to commit analysis (conflicts with `--bump`) |
| `-m, --message` | Tag message |
| `-g, --generate` | AI-generate message |
| `-S, --sign` | GPG sign tag |
@@ -334,6 +347,7 @@ quicommit config reset --force
| `-p, --push` | Push to remote |
| `-r, --remote` | Specify remote repository (default: origin) |
| `--dry-run` | Dry run |
| `-t, --think` | Enable LLM thinking/reasoning mode (overrides config) |
| `-y, --yes` | Skip confirmation |
### Changelog Options
@@ -341,16 +355,16 @@ quicommit config reset --force
| Option | Description |
|--------|-------------|
| `-o, --output` | Output file path |
| `-v, --version` | Generate for specific version |
| `-f, --from` | Generate from specific tag |
| `--version` | Generate for specific version |
| `-f, --from` | Generate from specific tag (auto-detected from existing changelog if omitted) |
| `-t, --to` | Generate to specific ref (default: HEAD) |
| `-i, --init` | Initialize new changelog file |
| `-g, --generate` | AI-generate changelog |
| `--prepend` | Prepend to existing changelog |
| `--include-hashes` | Include commit hashes |
| `--include-authors` | Include authors |
| `--format` | Format (keep-a-changelog, github-releases) |
| `--dry-run` | Dry run (output to stdout) |
| `--think` | Enable LLM thinking/reasoning mode (overrides config) |
| `-y, --yes` | Skip confirmation |
## Configuration File