copilot-powerline 0.13.0

A fast, customizable powerline status line for GitHub Copilot CLI
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

# Releasing copilot-powerline

`copilot-powerline` is released to two channels from the same version:

- crates.io, for `cargo install copilot-powerline`
- GitHub Releases with prebuilt binaries, a shell installer, and checksums, built by [dist](https://github.com/axodotdev/cargo-dist) (`.github/workflows/release.yml`, configured in `dist-workspace.toml`)

Prebuilt targets are macOS and Linux on arm64 and x86_64.

On each release the workflow also pushes an updated formula to [xpepper/homebrew-tap](https://github.com/xpepper/homebrew-tap). This needs a `HOMEBREW_TAP_TOKEN` repository secret: a token with write access to the tap repository's contents. Do not advertise a target as supported unless CI verifies it.

The workflow then publishes the crate to crates.io (`.github/workflows/publish-crates.yml`, a dist custom publish job). It runs only after the GitHub Release exists, because a crates.io version cannot be deleted or re-uploaded. It authenticates with [crates.io trusted publishing](https://crates.io/docs/trusted-publishing), so there is no token secret. The one-time setup is in the crate's settings on crates.io, under Trusted Publishing, with repository owner `xpepper`, repository `copilot-powerline`, and workflow `release.yml`. crates.io checks the calling workflow, not `publish-crates.yml`.

## Shortcut: `scripts/release.sh`

The steps below are automated by two commands. Merging the version-bump PR stays manual, as the review point. Pass `--dry-run` (or `-n`) to preview the planned commands without modifying state.

```bash
# Optional preview:
scripts/release.sh --dry-run prepare 0.5.2

scripts/release.sh prepare 0.5.2   # bump, run the checks, open the bump PR
# review and merge the PR, then:
scripts/release.sh --dry-run tag   # optional preview
scripts/release.sh tag             # tag main, watch the run, verify crates.io, append notes
```

The manual steps follow, for when the script cannot be used.

## Prepare a release

1. Start from an up-to-date `main` branch with the required CI checks passing.
2. Update the package version in `Cargo.toml` and any user-facing version references.
3. Review the README installation instructions and compatibility notes.
4. Run the release checks:

   ```bash
   cargo fmt --all --check
   cargo clippy --all-targets -- -D warnings
   cargo test --verbose
   cargo build --release --verbose
   cargo publish --dry-run
   dist plan
   ```

   If you changed `dist-workspace.toml` or upgraded dist, run `dist generate` and commit the regenerated workflow; the release workflow fails when it is out of date.

5. Open and merge the version-bump pull request.

## Tag

From the merged release commit on `main`, replace the example version and push an annotated tag. Do not run `cargo publish` by hand: the workflow does it.

```bash
VERSION=0.3.2
git tag -a "v$VERSION" -m "v$VERSION"
git push origin "v$VERSION"
```

Pushing the tag starts the Release workflow, which builds every target, creates the GitHub Release with the binaries, `copilot-powerline-installer.sh`, and checksums, then publishes the Homebrew formula and the crate. Do not create the release by hand with `gh release create`: the workflow creates it.

If the crates.io job fails, fix the cause and re-run the failed jobs. The job skips a version that is already on crates.io, so a re-run is safe.

When the workflow has finished, append GitHub's generated notes to the release body:

```bash
NOTES=$(gh api "repos/xpepper/copilot-powerline/releases/generate-notes" -f tag_name="v$VERSION" --jq .body)
BODY=$(gh release view "v$VERSION" --json body --jq .body)
gh release edit "v$VERSION" --notes "$BODY

$NOTES"
```

## After publishing

Confirm that the crates.io version and GitHub tag agree, and that the installer works:

```bash
cargo search copilot-powerline --limit 1
cargo binstall copilot-powerline --no-confirm
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/xpepper/copilot-powerline/releases/latest/download/copilot-powerline-installer.sh | sh
copilot-powerline --version
brew upgrade xpepper/tap/copilot-powerline || brew install xpepper/tap/copilot-powerline
```

Then update any launch or distribution material to use the published version and the installation commands in the README.