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
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "fastaguard"
version = "0.1.0"
version = "0.1.1"
edition = "2021"
license = "MIT"
description = "FASTA preflight QC for assembly pipelines"
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,7 @@ FastaGuard catches FASTA-level assembly problems before expensive assembly QC.
- [LLM and tooling vision](docs/llm-tooling-vision.md)
- [Benchmarking](docs/benchmarking.md)
- [Packaging](docs/packaging.md)
- [v0.1.1 release notes](docs/releases/v0.1.1.md)
- [v0.1.0 release notes](docs/releases/v0.1.0.md)
- [Roadmap](docs/roadmap.md)
- [First-release design](docs/superpowers/specs/2026-05-18-fastaguard-first-release-design.md)
Expand Down
6 changes: 3 additions & 3 deletions docs/packaging.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@ For the first public release:
1. Tag the release:

```bash
git tag v0.1.0
git push origin v0.1.0
git tag v0.1.1
git push origin v0.1.1
```

2. Push the tag to trigger `.github/workflows/release.yml`.
Expand Down Expand Up @@ -120,7 +120,7 @@ Once the Bioconda recipe is merged upstream, BioContainers can build the corresp

## MultiQC

FastaGuard v0.1.0 emits MultiQC custom content as `fastaguard_mqc.json`.
FastaGuard emits MultiQC custom content as `fastaguard_mqc.json`.

A native MultiQC plugin starter now lives in:

Expand Down
45 changes: 45 additions & 0 deletions docs/releases/v0.1.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# FastaGuard v0.1.1

FastaGuard v0.1.1 is a packaging metadata release for downstream adoption.

The CLI behavior remains assembly-focused and compatible with v0.1.0. The
important change is that the source tree now includes the metadata needed for a
clean Bioconda submission.

## Highlights

- Adds an MIT `LICENSE` file to the source archive.
- Adds Bioconda recipe scaffolding under `packaging/bioconda/`.
- Adds a native MultiQC plugin starter under `integrations/multiqc/`.
- Adds adoption, tool landscape, and benchmark evidence planning docs.
- Updates CI and release workflows to Node 24-compatible GitHub action versions.

## Install From Release Assets

Download the archive for your platform, unpack it, and place `fastaguard` on
`PATH`:

```bash
tar -xzf fastaguard-v0.1.1-x86_64-unknown-linux-gnu.tar.gz
./fastaguard-v0.1.1-x86_64-unknown-linux-gnu/fastaguard --help
```

## Bioconda Note

This release is intended to be the first source archive suitable for Bioconda:
it contains the project license file and the stable v0.1 FASTA preflight
contract commands:

```bash
fastaguard --help
fastaguard --schema
fastaguard --finding-catalog
```

## Known Limits

- v0.1.1 still supports the `assembly` profile only.
- FastaGuard does not estimate biological completeness, taxonomic
contamination, or assembly correctness.
- Bioconda submission still requires the public source archive SHA256 to be
recorded in the recipe.
2 changes: 1 addition & 1 deletion examples/reports/assembly_fail/fastaguard.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"schema_version": "0.1.0",
"tool": {
"name": "FastaGuard",
"version": "0.1.0"
"version": "0.1.1"
},
"input": {
"path": "testdata/problem_assembly.fa",
Expand Down
2 changes: 1 addition & 1 deletion examples/reports/assembly_fail/fastaguard_report.html
Original file line number Diff line number Diff line change
Expand Up @@ -363,7 +363,7 @@ <h2>JSON</h2>
&quot;schema_version&quot;: &quot;0.1.0&quot;,
&quot;tool&quot;: {
&quot;name&quot;: &quot;FastaGuard&quot;,
&quot;version&quot;: &quot;0.1.0&quot;
&quot;version&quot;: &quot;0.1.1&quot;
},
&quot;input&quot;: {
&quot;path&quot;: &quot;testdata/problem_assembly.fa&quot;,
Expand Down
2 changes: 1 addition & 1 deletion examples/reports/assembly_pass/fastaguard.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"schema_version": "0.1.0",
"tool": {
"name": "FastaGuard",
"version": "0.1.0"
"version": "0.1.1"
},
"input": {
"path": "testdata/valid_assembly.fa",
Expand Down
2 changes: 1 addition & 1 deletion examples/reports/assembly_pass/fastaguard_report.html
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ <h2>JSON</h2>
&quot;schema_version&quot;: &quot;0.1.0&quot;,
&quot;tool&quot;: {
&quot;name&quot;: &quot;FastaGuard&quot;,
&quot;version&quot;: &quot;0.1.0&quot;
&quot;version&quot;: &quot;0.1.1&quot;
},
&quot;input&quot;: {
&quot;path&quot;: &quot;testdata/valid_assembly.fa&quot;,
Expand Down
2 changes: 1 addition & 1 deletion packaging/bioconda/meta.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{% set name = "fastaguard" %}
{% set version = "0.1.0" %}
{% set version = "0.1.1" %}

package:
name: {{ name|lower }}
Expand Down
2 changes: 1 addition & 1 deletion tests/golden/invalid_empty_record.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"schema_version": "0.1.0",
"tool": {
"name": "FastaGuard",
"version": "0.1.0"
"version": "0.1.1"
},
"input": {
"path": "testdata/invalid_empty_record.fa",
Expand Down
2 changes: 1 addition & 1 deletion tests/golden/problem_assembly.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"schema_version": "0.1.0",
"tool": {
"name": "FastaGuard",
"version": "0.1.0"
"version": "0.1.1"
},
"input": {
"path": "testdata/problem_assembly.fa",
Expand Down
2 changes: 1 addition & 1 deletion tests/golden/valid_assembly.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"schema_version": "0.1.0",
"tool": {
"name": "FastaGuard",
"version": "0.1.0"
"version": "0.1.1"
},
"input": {
"path": "testdata/valid_assembly.fa",
Expand Down
27 changes: 27 additions & 0 deletions tests/python/test_release_metadata.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
import tomllib
import unittest
from pathlib import Path


ROOT = Path(__file__).resolve().parents[2]


class ReleaseMetadataTest(unittest.TestCase):
def test_package_and_bioconda_recipe_target_v0_1_1(self):
cargo = tomllib.loads((ROOT / "Cargo.toml").read_text())
recipe = (ROOT / "packaging" / "bioconda" / "meta.yaml").read_text()

self.assertEqual(cargo["package"]["version"], "0.1.1")
self.assertIn('{% set version = "0.1.1" %}', recipe)

def test_v0_1_1_release_notes_exist(self):
notes = ROOT / "docs" / "releases" / "v0.1.1.md"

self.assertTrue(notes.exists())
text = notes.read_text()
self.assertIn("FastaGuard v0.1.1", text)
self.assertIn("packaging metadata", text)


if __name__ == "__main__":
unittest.main()