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
22 changes: 19 additions & 3 deletions .claude/skills/release/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,13 +155,29 @@ the version bump and broke `Cargo.lock` on the merge-back. Bumping on `develop`
Put it in `conda-recipe/meta.yaml`, PR to **`develop`**. It reaches `main` with the next
release. The tagged commit can never contain its own tarball's hash, so the in-repo recipe
always lags by one step; nothing builds from `main`'s copy (Bioconda's recipe is updated
separately).
separately; see the next step).

**Bioconda: don't let it fall through the cracks.** Updating the in-repo recipe publishes
nothing; Bioconda builds from `bioconda/bioconda-recipes`. eidolon went unpublished from
v2.0.0 to v4.0.0 because the "Add eidolon" PR (bioconda-recipes#67420) sat unreviewed
while every release updated only the in-repo copy, and the docs advertised a
`conda install` that found nothing. After each release, look:
```bash
curl -s https://api.anaconda.org/package/bioconda/eidolon | grep -o '"latest_version": "[^"]*"'
gh pr list -R bioconda/bioconda-recipes --search eidolon --state open
```
- **Package published:** Bioconda's autobump bot opens an "Update eidolon to X" PR on its
own. Check that it appears and gets merged.
- **Package not yet published:** update the open add-recipe PR by hand (version and
sha256 in `meta.yaml`, plus any `build.sh` change), and ask for a review if it is idle.
Either way, say where Bioconda stands in the report step. This is not a release gate:
the release stands without it, but it must not be forgotten.

10. **No merge-back.** `develop` already has the bump, so nothing comes back from `main`.
Confirm the release landed with `git merge-base --is-ancestor <develop-sha> origin/main`.

11. **Report** the tag, the asset count, whether the docs site serves, and anything not
verified. Update the release ticket to match, link it from the release notes, and
11. **Report** the tag, the asset count, whether the docs site serves, where Bioconda
stands, and anything not verified. Update the release ticket to match, link it from the release notes, and
close it.

## Gotchas that have actually bitten
Expand Down
4 changes: 2 additions & 2 deletions ONBOARDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,8 +147,8 @@ how you find them without an aligner.
## Getting it

```bash
conda install -c bioconda eidolon # or cargo build --release
eidolon --help
cargo build --release # or a release binary; Bioconda pending (#67420)
./target/release/eidolon --help
```

## Working on it
Expand Down
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,18 @@ are not quite bugs. See `CHANGELOG.md` for the full release history.

## Install

Download the binary for your system from the
[releases page](https://github.com/ncsa/eidolon/releases). It is self-contained, so no Rust
toolchain or environment is needed. For Linux:

```bash
conda install -c bioconda eidolon
mv eidolon-x86_64-unknown-linux-gnu eidolon && chmod +x eidolon
./eidolon --version
```

A prebuilt binary with dependencies handled, no Rust toolchain required. Release binaries and
build-from-source instructions are in the docs.
The other platforms and build-from-source instructions are in the docs. A Bioconda package
is not available yet; it is in review at
[bioconda-recipes#67420](https://github.com/bioconda/bioconda-recipes/pull/67420).

## A minimal run

Expand Down
20 changes: 10 additions & 10 deletions docs-site/src/getting-started/installation.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,7 @@
# Installing eidolon

Three routes. The first two need no Rust toolchain at all.

## Bioconda

```
conda install -c bioconda eidolon
```

A prebuilt binary with dependencies handled. This is the easiest route on a workstation
and works on a cluster wherever you already have conda.
Two routes today: a release binary, which needs no Rust toolchain, or building from source. A
Bioconda package is pending (below).

## A release binary

Expand Down Expand Up @@ -45,6 +37,14 @@ runs that subcommand directly.

Let us know if one of these does not work on your system.

## Bioconda (not yet available)

A Bioconda package is in review at
[bioconda-recipes#67420](https://github.com/bioconda/bioconda-recipes/pull/67420). Until it
is merged, `conda install -c bioconda eidolon` finds nothing. The package Bioconda does carry,
`rneat`, is this project under its earlier name, frozen at 1.20.1; use a release binary
instead.

## Building from source

You will need the Rust toolchain including `cargo`; see the
Expand Down
6 changes: 3 additions & 3 deletions docs-site/src/overview/comparison-with-neat.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ line), the current Python 3 NEAT 4.x, and `eidolon`.
| VCF comparison tooling | Bundled scripts | ✅ `compare-vcfs` | ✅ `compare-vcfs` |
| I/O / memory | Temp files | Temp files | Streaming writes, low-memory focus |
| Versioning policy | ad hoc | ad hoc | SemVer 2.0.0 with a declared public API (as of v3.0.0) |
| Distribution | GitHub source | GitHub / PyPI | GitHub + binaries; Bioconda (`conda install -c bioconda eidolon`) |
| Distribution | GitHub source | GitHub / PyPI | GitHub + binaries; Bioconda pending ([#67420](https://github.com/bioconda/bioconda-recipes/pull/67420)) |

Speed and memory are single-thread medians (n=3, 10× coverage) on one exclusive
Delta node against NEAT 4.6.1, measured on v4.0.0 (#840); see `docs/access_report_draft.md`
Expand Down Expand Up @@ -78,5 +78,5 @@ when you want:
- **Reproducibility** — the same seed yields byte-identical FASTQ regardless of
the thread count.
- **Easy deployment** — a single self-contained binary with no Python
environment to manage, installable via Bioconda
(`conda install -c bioconda eidolon`).
environment to manage. A Bioconda package is in review
([bioconda-recipes#67420](https://github.com/bioconda/bioconda-recipes/pull/67420)).
Loading