Home

Worktree Status

This enumeration is used with source metadata such as repository, path, and commit on CreativeWork and derived types.

It records whether the source worktree had uncommitted or untracked changes when the work metadata was captured. Omit the property when status was not checked or does not apply.

This avoids overloading the commit property with sentinel values such as "dirty" or "untracked" while still preserving the commit hash that the worktree state is relative to.

Members

The WorktreeStatus type has these members:

MemberDescription
CleanThe source worktree matched the recorded commit with no known uncommitted or untracked changes.
DirtyThe source worktree had tracked changes that were not represented by the recorded commit.
UntrackedThe source file or relevant worktree content was not tracked by version control.

Bindings

The WorktreeStatus type is represented in:


This documentation was generated from WorktreeStatus.yaml by docs_types.rs.

© 2026 Stencila