@usine/core/repository

Type Aliases

CommitSha

CommitSha = typeof CommitSha.Type

An exact Git commit recorded for a checkout or produced by an Attempt, unchanged when branch names move.

---

RepositoryName

RepositoryName = typeof RepositoryName.Type

Full owner/name of a GitHub repository, in the casing the operator wrote. Compare through canonicalRepositoryName, since GitHub ignores case.

---

RepositoryRevision

RepositoryRevision = typeof RepositoryRevision.Type

The branch, tag, commit, or HEAD a Worker fetches when preparing an Attempt; named refs resolve at preparation time.

Variables

canonicalRepositoryName

const canonicalRepositoryName: (repository) => string

Lowercases a repository name for comparison, since GitHub ignores case.

Parameters

Parameter	Type
repository	RepositoryName

Returns

string

---

CommitSha

const CommitSha: Schema.brand<Schema.String, "CommitSha">

An exact Git commit recorded for a checkout or produced by an Attempt, unchanged when branch names move.

---

RepositoryName

const RepositoryName: Schema.brand<Schema.String, "RepositoryName">

Full owner/name of a GitHub repository, in the casing the operator wrote. Compare through canonicalRepositoryName, since GitHub ignores case.

---

RepositoryRevision

const RepositoryRevision: Schema.brand<Schema.String, "RepositoryRevision">

The branch, tag, commit, or HEAD a Worker fetches when preparing an Attempt; named refs resolve at preparation time.

---

safeSegment

const safeSegment: (value) => string

Renders an identity as one path or ref segment: every character outside [A-Za-z0-9_.-] becomes _.

Parameters

Parameter	Type
value	string

Returns

string

---

splitRepositoryName

const splitRepositoryName: (repository) => object

Splits a repository name into its owner and name.

Parameters

Parameter	Type
repository	RepositoryName

Returns

object

name

readonly name: string

owner

readonly owner: string