Skip to content
This repository was archived by the owner on May 21, 2026. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 0 additions & 93 deletions .github/workflows/test.yml

This file was deleted.

68 changes: 0 additions & 68 deletions .github/workflows/update-formula.yml

This file was deleted.

55 changes: 17 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# homebrew-hawkop

Homebrew tap for [HawkOp](https://github.com/stackhawk/hawkop) — a CLI companion for the StackHawk AppSec Intelligence Platform.
Homebrew tap for [HawkOp](https://github.com/stackhawk/hawkop) — a CLI
companion for the StackHawk AppSec Intelligence Platform.

## Install

Expand All @@ -9,8 +10,11 @@ brew tap stackhawk/hawkop
brew install hawkop
```

> Requires a published release. If you see `Error: No available formula`, the
> first release has not yet been cut — see [Releasing a new version](#releasing-a-new-version).
To pin a specific version:

```sh
brew install stackhawk/hawkop/hawkop@0.6.1
```

## Upgrade

Expand All @@ -26,40 +30,15 @@ brew uninstall hawkop
brew untap stackhawk/hawkop
```

## Releasing a new version

The formula is auto-generated. Do **not** edit `Formula/hawkop.rb` by hand.

### Manual release

```sh
gh workflow run update-formula.yml \
-R stackhawk/homebrew-hawkop \
-f version=X.Y.Z
```

This triggers the `update-formula` workflow, which renders
`scripts/formula-template.rb` using SHA256 sidecars from
`download.stackhawk.com/hawkop/cli/` and commits the result to `main`.

### Automated release

Upstream `stackhawk/hawkop` can send a `repository_dispatch` event of type
`hawkop-release` with payload `{"version": "X.Y.Z"}` to this repo to trigger
the same workflow.

## Troubleshooting

**`brew install` fails with a checksum mismatch.**
The tarball was re-uploaded with different content than the formula recorded.
Re-run the update workflow for the affected version.
## How this tap is maintained

**`brew install` fails with HTTP 404.**
The formula is pinned to a version whose tarballs have not been published,
or the download bucket was rolled back. Check
`https://download.stackhawk.com/hawkop/cli/hawkop-v<VERSION>-<target>.tar.gz`
with `curl -I` and coordinate with the `stackhawk/hawkop` release owner.
Do not edit `Formula/*.rb` by hand. The formulae in this repo are
regenerated by the [`stackhawk/hawkop`](https://github.com/stackhawk/hawkop)
release pipeline on every prod release — that pipeline owns the template,
hashes the published tarballs, renders `Formula/hawkop.rb` (latest) and
`Formula/hawkop@<version>.rb` (pinned), and pushes the changes here as
the `runner` user.

**Shell renderer fails locally.**
Run `bats scripts/test-update-formula.bats` and
`shellcheck scripts/update-formula.sh` from the repo root.
If the formula needs to change (new platform, updated `test do` block,
etc.), edit `brew/hawkop.rb.template` in the upstream `hawkop` repo and
cut a release.
38 changes: 0 additions & 38 deletions scripts/formula-template.rb

This file was deleted.

80 changes: 0 additions & 80 deletions scripts/test-update-formula.bats

This file was deleted.

Loading