Conversation
|
Coverage after merging release/1.7.0 into main will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Coverage after merging release/1.7.0 into main will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
There was a problem hiding this comment.
Pull request overview
Release prep for v1.7.0, updating the package version and publishing corresponding release documentation in the VitePress blog and changelog.
Changes:
- Bump
package.jsonversion from1.6.1to1.7.0. - Add a new release blog post for v1.7.0 and link it from the blog index.
- Add v1.7.0 entry to
CHANGELOG.md.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| package.json | Updates the npm/package version to 1.7.0. |
| docs/blog/release-v1-7-0.md | Adds the v1.7.0 release post (completions + syntax highlighting highlights). |
| docs/blog/index.md | Adds v1.7.0 to the blog release index table. |
| CHANGELOG.md | Adds a v1.7.0 row pointing to the new blog post. |
| The completion scripts cover: | ||
|
|
||
| - All subcommands (`query`, `upgrade`, `completions`) | ||
| - All flags (`--org`, `--format`, `--output-type`, `--exclude-repositories`, `--exclude-extracts`, `--group-by-team-prefix`, `--no-interactive`, `--include-archived`, `--no-cache`, `--debug`) |
There was a problem hiding this comment.
The post claims the completion scripts cover all flags including --debug, but the completion generator metadata in src/completions.ts does not include a debug option, so the generated scripts won’t actually suggest it. Either add --debug to the completion option list (and consider scoping it to upgrade), or adjust this release note to match current completion behavior.
| - All flags (`--org`, `--format`, `--output-type`, `--exclude-repositories`, `--exclude-extracts`, `--group-by-team-prefix`, `--no-interactive`, `--include-archived`, `--no-cache`, `--debug`) | |
| - Commonly used flags (`--org`, `--format`, `--output-type`, `--exclude-repositories`, `--exclude-extracts`, `--group-by-team-prefix`, `--no-interactive`, `--include-archived`, `--no-cache`) |
| ```bash | ||
| # bash | ||
| github-code-search completions --shell bash >> ~/.bashrc | ||
|
|
||
| # zsh (place the script in a $fpath directory) | ||
| github-code-search completions --shell zsh > ~/.zfunc/_github-code-search | ||
|
|
||
| # fish | ||
| github-code-search completions --shell fish > ~/.config/fish/completions/github-code-search.fish | ||
| ``` | ||
|
|
||
| When `--shell` is omitted, the shell is auto-detected from `$SHELL`. | ||
|
|
||
| The completion scripts cover: | ||
|
|
||
| - All subcommands (`query`, `upgrade`, `completions`) | ||
| - All flags (`--org`, `--format`, `--output-type`, `--exclude-repositories`, `--exclude-extracts`, `--group-by-team-prefix`, `--no-interactive`, `--include-archived`, `--no-cache`, `--debug`) | ||
| - Enumerated flag values where applicable (`--format markdown|json`, `--output-type repo-and-matches|repo-only`) | ||
|
|
||
| #### Auto-refresh on upgrade | ||
|
|
||
| If you have installed completions, they are **refreshed automatically** every time you run `github-code-search upgrade`. No manual action needed — the completion file is overwritten in-place. | ||
|
|
There was a problem hiding this comment.
The bash install example appends the generated script into ~/.bashrc, but the “Auto-refresh on upgrade” note below only applies when completions are written to the standard completion file path that upgrade refreshes (or when installed via install.sh). As written, users who follow the >> ~/.bashrc approach won’t get auto-refresh and may accumulate duplicate definitions; consider changing the bash example to the recommended install method (e.g. sourcing from the completion file path or using the eval "$(...)" pattern) and clarifying the auto-refresh requirement.
| The `install.sh` script now calls `install_completions()` at the end of an installation, writing the completion file for the detected shell: | ||
|
|
||
| ```bash | ||
| curl -sSL https://raw.githubusercontent.com/fulll/github-code-search/main/install.sh | bash |
There was a problem hiding this comment.
The install command uses curl -sSL ... | bash. Using -f as well (-fsSL) is safer because it fails on non-2xx HTTP responses instead of piping an error page into the shell; this also matches the usage shown at the top of install.sh.
| curl -sSL https://raw.githubusercontent.com/fulll/github-code-search/main/install.sh | bash | |
| curl -fsSL https://raw.githubusercontent.com/fulll/github-code-search/main/install.sh | bash |
No description provided.