Skip to content

README: show the pinned-version install line the release test requires #1103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
santoshkumarradha merged 2 commits into from
Sep 17, 2026
Merged

README: show the pinned-version install line the release test requires #1103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dadd55c
README: show the pinned-version install line the release test requires
santoshkumarradha Sep 17, 2026
f581df4
docs: the change entry for the README pin example
santoshkumarradha Sep 17, 2026
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
13 changes: 10 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,16 @@ codeaf
```

The script puts the release binary for your platform in `~/.codeaf/bin`. To
build it yourself: `git clone`, `make build`, `bin/codeaf`
([guide](docs/GUIDE.md#install)). Release assets, checksums and version
pinning are on the [releases page](https://github.com/Agent-Field/codeaf/releases).
pin a version, give it a tag from the
[releases page](https://github.com/Agent-Field/codeaf/releases), where the
assets and checksums also live:

```bash
curl -fsSL https://agentfield.ai/get/codeaf | VERSION=<tag> bash
```

To build it yourself: `git clone`, `make build`, `bin/codeaf`
([guide](docs/GUIDE.md#install)).

On first start it asks for a key: OpenRouter, DeepSeek, GLM, Kimi, MiniMax or
Qwen. Ollama needs none.
Expand Down
13 changes: 13 additions & 0 deletions docs/changes/unreleased/1103-readme-pin-example.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
kind: fixed
title: The README shows how to pin a release version again
pr: 1103
surface: [docs]
invalidates:
- "The README said only that version pinning is on the releases page. Its Install section now shows the pin inline: `curl -fsSL https://agentfield.ai/get/codeaf | VERSION=<tag> bash`."
- "`TestPublishedPinExamplesGiveVersionToBash` failed on a clean `dev` checkout after the README rewrite. It passes; every published install surface gives `VERSION` to bash, not to curl."
---

The pin goes after the pipe because `VERSION=<tag> curl ...` sets the variable
for curl and the install script never sees it; the release test guards every
page that shows an install line against that spelling.
Loading