Skip to content

About

Base libraries for "Git as the Persistence of Versioned Documents"

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

git-document-repository

Status

Java CI with Maven License Maven Central

Quality Gate Status Lines of Code Coverage

What is it?

Base libraries for Git as the Persistence of Versioned Documents: a server-side Git repository as the persistence of an application in which users maintain versioned documents (OWASP SAMM assessments, threat models, incident response reports, ISMS). Git is the persistence only, not a user-facing tool; the libraries build on JGit and work in memory, without working trees.

The documentation starts at doc/README.adoc: concepts, architecture decisions and specification. The repository is a multi-module Maven reactor whose modules are released together but consumed separately.

Module Content

git-core

Hardened repositories, remote policy, identity, results, transport, reading, cache repository, in-core writing, compare-and-swap, in-core merge, notes; linked working trees, commit from a working tree, working-tree status.

git-testing

Generators and fixtures: local and in-memory repositories, a local remote.

git-store

Repository registry, typed configuration, codec interface, outcome list and result, service interfaces with provider selection. Depends on git-core only.

git-core holds the repository part taken over from its first client: hardening, remote policy, identity, results, repository operations and the cache repository, plus in-core writing, compare-and-swap reference updates, in-core merge, reading (snapshot, path history, changed paths) and notes. Its package de.cuioss.git.document.core.worktrees holds the worktree part taken over from the same client: adding, listing and removing linked working trees and the commit from a working tree, plus a new working-tree status. git-testing holds its credential generator and its repository fixtures (see Module Structure and Client: pm-mcp-core). git-store holds the foundation of the document store: the registry of its repositories, the typed configuration checked at start, the codec interface, its own outcome list and result, and the service interfaces for signing keys, anchor proofs and the person directory with the selection of their providers; drafts, saving, release and anchoring follow. The other aspect modules (git-forms, git-timestamp, git-directory) follow as the document store needs them.

The build guards the layering and the consumer closure of git-core: a module that declares a dependency on another module outside the module graph fails the build, and so does a compile or runtime artifact outside the closure a consumer of git-core alone receives. git-core ships the GraalVM native-image metadata for the JGit classes it reaches; git-store relies on it (see General Requirements, GDR-GEN-1 and GDR-NFR-4).

Maven Coordinates

    <dependency>
        <groupId>de.cuioss</groupId>
        <artifactId>git-core</artifactId>
    </dependency>

Credentials

All secrets (GPG, Sonatype, Sonar, Release App) are managed at the cuioss organization level. The caller workflows pass them explicitly to the reusable workflows; pass only the secrets a reusable workflow declares, an undeclared one makes every run end in startup_failure. No repo-level secrets need to be configured.

Releasing

Merging a change of release.current-version in .github/project.yml is a release: the central guard in reusable-maven-release.yml publishes to Maven Central whenever that value differs from the merge commit’s first parent and no tag for it exists. Maven Central releases cannot be withdrawn. Every other project.yml edit reaches the release workflow too and is refused by the guard.

  • current-version: 0.1.0 is declared together with 0.1.0-SNAPSHOT in the poms. Do not touch it in an ordinary PR. The first release is a deliberate workflow_dispatch from main, and only once the modules contain code.

  • Every later release goes through the runbook .claude/skills/release/SKILL.md: a dedicated chore/release_<version> PR that changes nothing but the version, merged only after the pre-cut checks.

  • Do not rewrite the cuioss/cui-java-module-template literal in .github/workflows/release.yml; it only excludes the template repository itself.

  • maven-build.enable-snapshot-deploy is true: every push to main deploys the 0.1.0-SNAPSHOT modules to the Sonatype snapshot repository. This is not a release.

About

Base libraries for "Git as the Persistence of Versioned Documents"

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages