Skip to main content

Crate ticgit_lib

Crate ticgit_lib 

Source
Expand description

§ticgit-lib

Ticket-tracking on top of git-meta.

Tickets live as project-target metadata under the ticgit: namespace:

ticgit:tickets:<uuid>:title          # string
ticgit:tickets:<uuid>:description    # string (optional)
ticgit:tickets:<uuid>:status         # string ("open" | "closed")
ticgit:tickets:<uuid>:state          # string ("new" | "blocked" | ...)
ticgit:tickets:<uuid>:assigned       # string (optional)
ticgit:tickets:<uuid>:points         # string (optional integer)
ticgit:tickets:<uuid>:milestone      # string (optional)
ticgit:tickets:<uuid>:tags           # set
ticgit:tickets:<uuid>:meta:<key>     # string
ticgit:tickets:<uuid>:comments       # list of JSON-encoded {author, body}
ticgit:tickets:<uuid>:created-at     # RFC3339 string
ticgit:tickets:<uuid>:created-by     # string (email)
ticgit:writeups:<uuid>:title         # string
ticgit:writeups:<uuid>:status        # string ("open" | "closed")
ticgit:writeups:<uuid>:tags          # set
ticgit:writeups:<uuid>:authors       # set of emails
ticgit:writeups:<uuid>:versions      # list of markdown documents
ticgit:writeups:<uuid>:tickets       # set of linked ticket UUIDs
ticgit:views:<name>                  # set of UUIDs (saved selection)
ticgit:owners                        # set of emails
ticgit:schema-version                # string ("1")

See the top-level README.md and docs/schema/v1.json for higher-level docs and the stable JSON machine-output schema.

Re-exports§

pub use error::Error;
pub use error::Result;
pub use query::Filter;
pub use query::SearchFilter;
pub use query::SearchScope;
pub use query::SortKey;
pub use query::SortOrder;
pub use store::TicketStore;
pub use ticket::validate_code_uri;
pub use ticket::Comment;
pub use ticket::NewTicketOpts;
pub use ticket::Ticket;
pub use ticket::TicketLifecycle;
pub use ticket::TicketState;
pub use ticket::TicketStatus;
pub use writeup::NewWriteupOpts;
pub use writeup::Writeup;
pub use writeup::WriteupStatus;
pub use writeup::WriteupVersion;

Modules§

error
Error types for the ticgit library.
keys
Centralised key-string layout for ticgit metadata.
query
Filtering and sorting for ti list.
store
TicketStore - the bridge between the Ticket domain model and a git-meta Session.
ticket
Domain types for tickets, comments, and ticket states.
writeup

Structs§

Session
Re-exported for callers who want to talk to git-meta directly. A session combining a Git repository with its gmeta metadata store.
Target
Re-exported for callers who want to talk to git-meta directly. A resolved metadata target consisting of a type and an optional value.

Enums§

MetaValue
Re-exported for callers who want to talk to git-meta directly. A metadata value with its type.