git-commit

Import

Import

import * as api from "@fungi.computer/agar/git-commit";

Exports

Kind	Export	Description
Ttype alias	GitCommitStore	The binding operations these writes use.
Ttype alias	GitFileChange	One file to write (content) or delete (content: null), repository-relative.
Ttype alias	GitIdentity	Name and email recorded as a commit’s author and committer.
Ttype alias	CommitFilesRequest	A commit of file changes to one branch.
Ttype alias	GitWriteOutcome	What a compare-and-swap write did.
Ttype alias	MergeBranchRequest	Merge a branch of source (such as a fork) into a branch of target.
Ttype alias	GitMergeOutcome	What a merge did. Merges always write a merge commit when there is new work.
Ttype alias	MoveRefRequest	Point a ref at a commit that is the head of source.
Ttype alias	MoveRefsRequest	Ordered ref moves to one fetched source commit; each move has its own CAS guard.
Ttype alias	GitRefMovesOutcome	Earlier moves remain accepted if a later ref is stale; this is not an atomic push.
fnfunction	commitFiles()	Commit files using independently resumable, CAS-guarded Git steps.
fnfunction	moveRef()	Point a ref at the head commit of source, compare-and-swap on the ref.
fnfunction	moveRefs()	Fetch a source once, then move refs in order with separate guarded pushes.
fnfunction	mergeBranch()	Merge branches through the same one-exchange step engine as background owners.

GitCommitStoreTtype alias

Signature

type GitCommitStore = Pick<GitBinding, "exchange">;

The binding operations these writes use.

---

GitFileChangeTtype alias

Signature

type GitFileChange = Readonly<{
  path: string;
  content: Uint8Array | null;
  mode?: "100644" | "100755";
}>;

One file to write (content) or delete (content: null), repository-relative.

---

GitIdentityTtype alias

Signature

type GitIdentity = Readonly<{
  name: string;
  email: string;
}>;

Name and email recorded as a commit’s author and committer.

---

CommitFilesRequestTtype alias

Signature

type CommitFilesRequest = Readonly<{
  repository: string;
  branch: string;
  expectedHead: string | null;
  startFrom?: string;
  changes: readonly GitFileChange[];
  message: string;
  author: GitIdentity;
}>;

A commit of file changes to one branch.

---

GitWriteOutcomeTtype alias

Signature

type GitWriteOutcome =
  | Readonly<{
      kind: "committed";
      commit: string;
    }>
  | Readonly<{
      kind: "unchanged";
      commit: string;
    }>
  | Readonly<{
      kind: "updated";
    }>
  | Readonly<{
      kind: "stale";
      head: string | null;
    }>;

What a compare-and-swap write did.

---

MergeBranchRequestTtype alias

Signature

type MergeBranchRequest = Readonly<{
  target: string;
  source: string;
  branch: string;
  sourceBranch: string;
  expectedSource: string;
  expectedTarget?: string;
  behind?: number;
  message: string;
  author: GitIdentity;
}>;

Merge a branch of source (such as a fork) into a branch of target.

---

GitMergeOutcomeTtype alias

Signature

type GitMergeOutcome =
  | Readonly<{
      kind: "merged";
      before: string;
      after: string;
    }>
  | Readonly<{
      kind: "up-to-date";
      head: string;
    }>
  | Readonly<{
      kind: "conflict";
      head: string;
      paths: readonly string[];
    }>
  | Readonly<{
      kind: "stale";
      head: string | null;
    }>
  | Readonly<{
      kind: "source-moved";
      head: string;
    }>;

What a merge did. Merges always write a merge commit when there is new work.

---

MoveRefRequestTtype alias

Signature

type MoveRefRequest = Readonly<{
  repository: string;
  ref: string;
  expected: string | null;
  commit: string;
  source: string;
}>;

Point a ref at a commit that is the head of source.

---

MoveRefsRequestTtype alias

Signature

type MoveRefsRequest = Readonly<{
  repository: string;
  source: string;
  commit: string;
  updates: readonly Readonly<{
    ref: string;
    expected: string | null;
  }>[];
}>;

Ordered ref moves to one fetched source commit; each move has its own CAS guard.

---

GitRefMovesOutcomeTtype alias

Signature

type GitRefMovesOutcome =
  | Readonly<{
      kind: "updated";
    }>
  | Readonly<{
      kind: "stale";
      ref: string;
      head: string | null;
    }>;

Earlier moves remain accepted if a later ref is stale; this is not an atomic push.

commitFiles()fnfunction

Signature

function commitFiles(store, request, beforeWrite?): Promise<GitWriteOutcome>;

Commit files using independently resumable, CAS-guarded Git steps.

Parameters

Parameter	Type
store	GitCommitStore
request	CommitFilesRequest
beforeWrite?	() => Promise<void>

Returns

Promise<GitWriteOutcome>

---

moveRef()fnfunction

Signature

function moveRef(store, request): Promise<GitWriteOutcome>;

Point a ref at the head commit of source, compare-and-swap on the ref.

Parameters

Parameter	Type
store	GitCommitStore
request	MoveRefRequest

Returns

Promise<GitWriteOutcome>

---

moveRefs()fnfunction

Signature

function moveRefs(store, request): Promise<GitRefMovesOutcome>;

Fetch a source once, then move refs in order with separate guarded pushes.

Parameters

Parameter	Type
store	GitCommitStore
request	MoveRefsRequest

Returns

Promise<GitRefMovesOutcome>

---

mergeBranch()fnfunction

Signature

function mergeBranch(store, request): Promise<GitMergeOutcome>;

Merge branches through the same one-exchange step engine as background owners.

Parameters

Parameter	Type
store	GitCommitStore
request	MergeBranchRequest

Returns

Promise<GitMergeOutcome>