ARC knowledge

Versioning

Research data and their descriptions change during a project. New results, corrected annotations, and additional context need a history that collaborators can follow. A publication, meanwhile, needs an identifiable version of the output being described.

#Workspace history and publication versions

An ARC Workspace can continue to develop before and after a publication. Versioning records stages of that work so that changes can be reviewed and particular states identified.

The ISA ARC Workspace uses Git for this purpose. Commits record snapshots and their history; branches support parallel contributions. Git is a convention of that domain implementation; ARC RDM permits other working environments with a defined transformation into ARC RO-Crate.

Git history records changes to the workspace. Identity by Provenance concerns the experimental, computational, and other research activities that generated, used, or transformed research objects. The Provenance Core supplies structures for those descriptions. A commit history and scientific process descriptions answer different questions.

#Collaboration in a Git-based workspace

Git supports shared work through many hosting platforms. Collaborators can review contributions and coordinate changes to data and metadata. Clear conventions for identifiers and organization remain necessary when combining their work.

Git-based workspace example: collaborators contribute changes to shared research

Git LFS is used in established ARC implementations to manage large files alongside Git-tracked metadata. The storage and access arrangements depend on the chosen hosting environment.

#Publication versions

Compilation can prepare a selected workspace state as ARC RO-Crate. To make that result traceable, distinguish the versions involved:

VersionWhat it identifies
Workspace revisionThe recorded data and metadata used as input
Compiler version and configurationThe software and transformation rules used to interpret that input
Profile versionsThe selected Core and Extension Profile requirements for the output
Publication versionThe release identified and maintained by a publication service

A reproducible compilation should record the first three alongside its result. Equivalent inputs and conditions should yield equivalent entities and relationships, even if JSON formatting differs. A generated crate can be inspected or validated without being published or becoming immutable.

A publication service can provide persistent identification and access to a deposited version. A Git commit identifies a state in repository history; it does not replace those preservation arrangements. Later workspace changes can inform a new publication version through the relevant publication process.

See publication and exchange for the distinction between generating metadata, assessing requirements, and publishing an output.