diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..d4aa735 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,87 @@ +name: Release + +# A tag such as v0.1.0 makes a release: its notes are that version's section +# of CHANGELOG.md, and it carries the binary built for Linux and macOS, the +# systems iq's sandbox is written for, with a checksum for each. It is a full +# release, not a pre-release, so that GitHub shows it as the latest on the +# repository's page; the 0.x version and the notes already say iq is an +# experiment. As in CI, only GitHub's own actions run, each pinned to the +# commit of its release, and Rust comes from rustup. + +on: + push: + tags: ["v*"] + +env: + CARGO_TERM_COLOR: always + +jobs: + create: + name: Create the release + runs-on: ubuntu-latest + permissions: + contents: write + steps: + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 + with: + persist-credentials: false + # The tag and the manifest state the version in two places, and two + # places drift: a binary would say one version (its user agent among + # them) and its release another. + - name: The tag is the manifest's version + run: | + declared=$(sed -n 's/^version *= *"\([^"]*\)".*/\1/p' Cargo.toml | head -1) + echo "Cargo.toml says $declared, the tag is $GITHUB_REF_NAME" + if [ "v$declared" != "$GITHUB_REF_NAME" ]; then + echo "::error::the tag $GITHUB_REF_NAME is not the version Cargo.toml declares, $declared" + exit 1 + fi + - name: Notes from the changelog + run: | + version="${GITHUB_REF_NAME#v}" + awk -v v="$version" '/^## /{p = ($2 == v)} p' CHANGELOG.md | tail -n +2 > notes.md + test -s notes.md || { echo "::error::CHANGELOG.md has no section for $version"; exit 1; } + gh release create "$GITHUB_REF_NAME" --title "iq $GITHUB_REF_NAME" --notes-file notes.md --latest + env: + GH_TOKEN: ${{ github.token }} + + build: + name: Build (${{ matrix.target }}) + needs: create + permissions: + contents: write + strategy: + fail-fast: false + matrix: + include: + # The oldest Ubuntu GitHub still runs, rather than the latest: a + # binary needs at least the glibc it was linked against, and 22.04's + # is old enough for most distributions in use. + - os: ubuntu-22.04 + target: x86_64-unknown-linux-gnu + - os: macos-latest + target: aarch64-apple-darwin + runs-on: ${{ matrix.os }} + steps: + - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 + with: + persist-credentials: false + - name: Rust + run: | + rustup toolchain install stable --profile minimal + rustup default stable + - name: Build + run: cargo build --release --locked + - name: Package + run: | + name="iq-${GITHUB_REF_NAME}-${{ matrix.target }}" + mkdir "$name" + cp target/release/iq README.md LICENSE CHANGELOG.md "$name"/ + tar czf "$name.tar.gz" "$name" + shasum -a 256 "$name.tar.gz" > "$name.tar.gz.sha256" + - name: Attach to the release + run: | + name="iq-${GITHUB_REF_NAME}-${{ matrix.target }}" + gh release upload "$GITHUB_REF_NAME" "$name.tar.gz" "$name.tar.gz.sha256" + env: + GH_TOKEN: ${{ github.token }} diff --git a/AGENTS.md b/AGENTS.md index 12d9332..ef1a3e0 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -119,6 +119,10 @@ A plugin is a program of its own, apart from iq's binary, which iq starts only w - `# Examples` for non-trivial functions - Comments explain WHY, not what the name already says +## Releases + +A version is released by a tag `vX.Y.Z` equal to the workspace's version in `Cargo.toml`, pushed once `CHANGELOG.md` has a section `## X.Y.Z (date)` saying what changed since the last tag. `.github/workflows/release.yml` refuses a tag that disagrees with the manifest, makes the release from that section and attaches the binaries for Linux and macOS, each with its checksum. The version is also what iq's calls say they come from (`User-Agent: iq/`). + ## Commands ```bash diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..4f2fdbe --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,15 @@ +# Changelog + +Versions follow [semantic versioning](https://semver.org). While the version is 0.x iq is an experiment: anything may change or disappear from one version to the next, commands, keys, settings and file formats included, without a way back. + +## 0.1.0 (2026-11-14) + +The first version: a harness for coding agents in the terminal, on your machine, its models answering through Requesty's router. It is experimental, its security has not been audited, it is barely tested in real use, and whatever it does may change or be removed in the next version. + +- A lead agent takes your request and may start other agents, with the roles, models and efforts it chooses, in a few patterns (alone, a lead and those it starts, a writer and its reviewer, a debate); they write to each other and to you on a shared board. `iq do` hands a task over at once. +- Everything an agent does goes through one gate, which allows, asks or refuses; commands run in the operating system's sandbox (Landlock and seccomp on Linux, Seatbelt on macOS), and an autopilot may answer for you within the policy you write for it. +- Every cost in view: each call, each turn as it runs, by model, by kind of work and over time, with a limit a turn may reach before you are asked whether it goes on. +- Chats kept between sessions, each in a git worktree of its own when you want it; your rules and skills given to the agents; the project's notes; MCP servers and plugins of your own; iq's folder synced through a repository of yours. +- The conversation drawn by iq itself: steps folded, diagrams drawn, links opened, what agents change shown as diffs, text selected and copied. + +The binaries are built for Linux (x86_64, glibc 2.35 or later) and macOS (Apple Silicon), each with its SHA-256 checksum. On macOS the binary is not signed: `xattr -d com.apple.quarantine iq` lets it open. On recent Ubuntu, the sandbox's network needs unprivileged user namespaces, which AppArmor may keep from programs by default. diff --git a/README.md b/README.md index 0282a36..0bb4d28 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,7 @@ iq --help ## Building -iq runs on Linux and macOS, the systems its sandbox is written for. +iq runs on Linux and macOS, the systems its sandbox is written for. Each [release](https://github.com/ngodzik/iq/releases) carries the binary built for Linux (x86_64) and macOS (Apple Silicon), with its checksum; its notes say what it needs to run, and `CHANGELOG.md` what changed. To build it from the source instead: ```bash cargo install --path . # builds the iq binary into ~/.cargo/bin