Skip to content

Commit

Permalink
docs(readme): add section about upgrading
Browse files Browse the repository at this point in the history
  • Loading branch information
benelan committed Mar 19, 2024
1 parent d8e98db commit a705e0b
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ body:
attributes:
label: Reproduction Version
description: The latest version that reproduces the issue (check `gh fzf version`)
placeholder: 0.7.0 # x-release-please-version
placeholder: v0.7.0 # x-release-please-version
validations:
required: true
- type: input
Expand Down
34 changes: 33 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ An fzf wrapper around the GitHub CLI.

- [gh fzf](#gh-fzf)
- [Installation](#installation)
- [Upgrading](#upgrading)
- [Usage](#usage)
- [`issue`](#issue)
- [`pr`](#pr)
Expand Down Expand Up @@ -55,6 +56,37 @@ An fzf wrapper around the GitHub CLI.
4. **[???](#usage)**
5. **PROFIT**

### Upgrading

To upgrade `gh-fzf` to the latest commit on `main`:

```sh
gh extension upgrade gh-fzf
```

You can also pin a version tag when installing an extension. If you already have
`gh-fzf` installed, you need to remove it first before pinning a version:

<!-- x-release-please-start-version -->

```sh
gh extension remove gh-fzf &&
gh extension install benelan/gh-fzf --pin "v0.7.0"
```

<!-- x-release-please-end -->

There is also a `stable` tag, which always points to the latest release.

See the [changelog](./CHANGELOG.md) for a list of features and fixes
released in each version.

To check which version you currently have installed:

```sh
gh fzf -v
```

## Usage

```sh
Expand All @@ -65,7 +97,7 @@ This extension adds a new command that wraps GitHub's `list` subcommands with
fzf to make them fuzzy findable. All of the arguments after `<command>` are
passed directly to `gh`. Because of the way shell works, you need to escape
quotes required by GitHub, e.g. [strings with whitespace](https://docs.github.com/en/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#use-quotation-marks-for-queries-with-whitespace).
There are example usages for each command in the sections below.
There are usage examples for each command in the sections below.

A preview of the current selection is displayed when navigating through the
resulting list. Each command has keybindings to further filter the list or to
Expand Down
2 changes: 1 addition & 1 deletion gh-fzf
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ set -e
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.

GH_FZF_VERSION="0.7.0" # x-release-please-version
GH_FZF_VERSION="v0.7.0" # x-release-please-version

# Usage info and logs {{{
# --------------------------------------------------------------------- {|}
Expand Down

0 comments on commit a705e0b

Please sign in to comment.