Skip to content
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
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

SimplyCubed Code is an autonomous coding agent you install into your own GitHub. Your team files an issue, the agent prepares a pull request in your repository, and one of your reviewers decides whether it ships.

> Beta, at `v0.1.9`. Product overview: [simplycubed.com/code](https://simplycubed.com/code?utm_source=github&utm_medium=readme&utm_campaign=code). See [Status](#status).
> Beta. Current release: `v0.1.9`. Product overview: [simplycubed.com/code](https://simplycubed.com/code?utm_source=github&utm_medium=readme&utm_campaign=code). See [Status](#status).

### Try it without letting it write anything

Expand Down Expand Up @@ -124,16 +124,18 @@ Start with [docs/setup.md](docs/setup.md). It walks through customer installatio

## Installation

Install the pinned release you want to run:
Install the pinned release you want to run. The current release is `v0.1.9`;
replace `<release-tag>` below with that tag, or with whichever release you have
validated:

```sh
go install github.com/simplycubed/code/cmd/simplycubed@v0.1.9
go install github.com/simplycubed/code/cmd/simplycubed@<release-tag>
simplycubed version
```

That prints `0.1.7`. Pre-1.0 releases follow semver with the usual caveat: minor
versions may still change behavior. Pin the tag you have validated rather than
floating on `@latest`.
With `v0.1.9`, that prints `0.1.9`. Pre-1.0 releases follow semver with the
usual caveat: minor versions may still change behavior. Pin the tag you have
validated rather than floating on `@latest`.

Then follow the [setup guide in `docs/setup.md`](docs/setup.md) to add the repository config, install the GitHub workflow, set the required credentials, and run the first issue through the system.

Expand Down
4 changes: 3 additions & 1 deletion STATUS.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,9 @@ Each job mints its own installation token scoped to one repository with
`contents`, `issues`, and `pull-requests` permissions only.

`v0.1.9` is the current release. `go install
github.com/simplycubed/code/cmd/simplycubed@v0.1.9` works today. `v0.1.2` and `v0.1.4` are retracted in `go.mod` because those tags pointed at the wrong
github.com/simplycubed/code/cmd/simplycubed@<release-tag>` works today when
`<release-tag>` is the release you want to pin, including `v0.1.9`. `v0.1.2`
and `v0.1.4` are retracted in `go.mod` because those tags pointed at the wrong
commits.

Upgrade from anything earlier. `v0.1.7` has a duplicate `env:` key in its copy
Expand Down
12 changes: 6 additions & 6 deletions docs/release.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# Release Process

`v0.1.0` is the first tagged SimplyCubed Code release. A tag means the code at
`v0.1.0` was the first tagged SimplyCubed Code release. A tag means the code at
that commit passed the repo gate (`make check`), the CLI version reports that
same release, and the maintainer published release notes for it.

## Versioning

Tags use semver with a leading `v` (`v0.1.0`, `v0.2.0`, ...). Before `v1.0.0`,
minor releases may still make breaking changes when the product or CLI shape
needs it. Patch releases are for backward-compatible fixes on an existing line.
Tags use semver with a leading `v` (`vX.Y.Z`). Before `v1.0.0`, minor releases
may still make breaking changes when the product or CLI shape needs it. Patch
releases are for backward-compatible fixes on an existing line.

## Cutting a release

Run the **tag-release** workflow from the Actions tab and give it the version
(`v0.1.6`). It checks out the remote tip of the default branch, verifies the
(`vX.Y.Z`). It checks out the remote tip of the default branch, verifies the
release is consistent, runs the gate, and creates the tag. Pushing that tag
triggers the release workflow, which publishes the notes.

Expand Down Expand Up @@ -42,6 +42,6 @@ For each tag:

## Binary releases

For `v0.1.0`, binary archives are deferred. The supported install path is
For now, binary archives are deferred. The supported install path is
`go install ...@<tag>`. If binary releases are added later, use GitHub Releases
and stamp the same version via `-ldflags`.
36 changes: 26 additions & 10 deletions docs/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,17 @@ You need:

## Install and configure

1. Install the CLI:
1. Install the CLI. The current release is `v0.1.9`; replace
`<release-tag>` below with that tag, or with whichever release you have
validated:

```sh
go install github.com/simplycubed/code/cmd/simplycubed@v0.1.9
go install github.com/simplycubed/code/cmd/simplycubed@<release-tag>
simplycubed version
```

With `v0.1.9`, `simplycubed version` prints `0.1.9`.

2. In the target repository, generate the setup files and labels:

```sh
Expand Down Expand Up @@ -244,15 +248,23 @@ Azure endpoint and API key.

## Watching it run before it writes

Two commands answer "is this configured correctly" without changing anything.
Two commands answer "is this configured correctly" without changing anything:

```sh
simplycubed preflight
```

That validates the repository config and the engine settings and exits. It is
what the workflow runs before installing the rest of the toolchain, so a
misconfigured repository finds out in seconds.

`simplycubed preflight` validates the repository config and the engine settings
and exits. It is what the workflow runs before installing the rest of the
toolchain, so a misconfigured repository finds out in seconds.
```sh
simplycubed run owner/repo#N --dry-run
```

`simplycubed run owner/repo#N --dry-run` runs the whole loop, including the
engine and your real gate, and skips the push and every GitHub write. It prints
what it would have done instead, and in Actions writes that to the run summary.
That runs the whole loop, including the engine and your real gate, and skips
the push and every GitHub write. It prints what it would have done instead, and
in Actions writes that to the run summary.

If something goes wrong, [troubleshooting.md](troubleshooting.md) starts from
the symptom.
Expand All @@ -261,7 +273,11 @@ the symptom.

If your Azure deployment name is not `gpt-5.4`, set it explicitly.

- Local CLI: pass `--model <deployment-name>`.
- Local CLI:

```sh
simplycubed run owner/repo#N --repo-dir . --model <deployment-name>
```
- GitHub Actions: uncomment and set `model:` in
`.github/workflows/simplycubed.yml`.

Expand Down