Release Process

This page summarizes the intended release/publishing flow for cellucid-r.

The full step-by-step checklist lives in:

• cellucid-r/PUBLISHING.md

Recommended release flow (high level)

1. Update DESCRIPTION version.

2. Update CITATION.cff to match the new version.

3. Update NEWS.md with user-visible changes.

4. Ensure tests pass (devtools::test() / R CMD check).

5. Merge to main.

6. Create a GitHub Release tag (e.g. v0.99.1).

7. Use CI to build a source tarball (cellucid_<version>.tar.gz).

8. Publish targets (depending on maturity):

   • GitHub (source of truth)

   • r-universe (easy binaries)

   • CRAN (manual submission)

   • Bioconductor (manual submission via contributions tracker)

What contributors should keep in mind

• The R package is an exporter that must remain compatible with the viewer format.

• Changes to file formats should be documented and tested.

• Apply format changes atomically across the R writer, Python writer/server, web reader, validators, tests, and format documentation; retain only the exact current schema.

Where to update docs

When export behavior changes, update:

• user guide API docs: Data Preparation API

• format spec: Export Directory Format (Specification)