IF Commons GitHub

physical/github

Written to: 6 requirements: 6 proved, 0 partly, 0 failing, 0 with no test recorded. 0002-anyfs-githost-store FR-006, 0002-anyfs-githost-store FR-013, 0002-anyfs-githost-store FR-004, 0002-anyfs-githost-store FR-009, 0002-anyfs-githost-store FR-010, 0002-anyfs-githost-store FR-011

GitHub's REST API as a repository of Git (HostApi): the branch's tip, the trees (a tree the host cuts short is read again folder by folder, so a listing is never partial), the blobs by name, the history of a path, and a commit made through the Git Data API: the blobs are made, then a tree on the tree of the commit the changes were checked at, then a commit, then the branch is moved to it with force: false, so that a branch that moved is refused by the host and never overwritten. One batch is one commit. A host that is GitHub Enterprise Server is the same API under /api/v3.

Limits, said once: the Git Data API makes no commit in a repository that has none yet (409, said as such: make the first commit another way); a blob is at most 100 MB for the host and the store refuses far less; a file is read through its blob, so a listing asks for each blob it has not seen, a few at a time; a commit is by the author and the committer the store names, and a host may show a verified signature for none of them (signing is off).

Source: commons/anyfs-githost/src/physical/github.ts

0 of 2 exports are imported by a test of the run. A test that imports an export may not call it or check what it returns.

githubApifunctionno test imports it
function githubApi(options: GithubApiOptions): HostApi

GitHub's API as a repository of Git.

GithubApiOptionstypeno test imports it
type GithubApiOptions = {
  readonly call: Call;
  readonly owner: string;
  readonly repo: string;
  /** How many blobs are made at once by a commit: 4 where left out. */
  readonly concurrency?: number;
};

What GitHub's client is made with.

Titles, headings, exports, tables, columns and requirements. Esc closes.