@usine/github/local-secrets

Classes

EnvironmentCredentialsError

Extends

• Schema.Class

Constructors

Constructor

new EnvironmentCredentialsError(…args): EnvironmentCredentialsError

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

EnvironmentCredentialsError

Properties

message

readonly message: string

---

SecretsFileError

Extends

• Schema.Class

Constructors

Constructor

new SecretsFileError(…args): SecretsFileError

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

SecretsFileError

Properties

message

readonly message: string

path

readonly path: string

reason

readonly reason: "read" | "permissions" | "parse"

Type Aliases

LocalSecretsError

LocalSecretsError = typeof LocalSecretsError.Type

---

SecretsFileReason

SecretsFileReason = typeof SecretsFileReason.Type

Variables

GITHUB_APP_SECRETS_PATH

const GITHUB_APP_SECRETS_PATH: ".usine/github-app.json" = ".usine/github-app.json"

---

loadLocalCredentials

const loadLocalCredentials: (root) => Effect.Effect<AppCredentials, EnvironmentCredentialsError | SecretsFileError, FileSystem.FileSystem | Path.Path>

Loads the orchestrator’s App credentials. An environment variable wins over its file field, and the file is not read when both variables are set.

Parameters

Parameter	Type
root	string & Brand

Returns

Effect.Effect<AppCredentials, EnvironmentCredentialsError | SecretsFileError, FileSystem.FileSystem | Path.Path>

---

LocalSecretsError

const LocalSecretsError: Schema.Union<readonly [typeof EnvironmentCredentialsError, typeof SecretsFileError]>

---

localSecretsLayer

const localSecretsLayer: (root) => Layer.Layer<GitHubCredentials, LocalSecretsError, FileSystem.FileSystem | Path.Path>

Parameters

Parameter	Type
root	InstanceDirectory

Returns

Layer.Layer<GitHubCredentials, LocalSecretsError, FileSystem.FileSystem | Path.Path>

---

SecretsFileReason

const SecretsFileReason: Schema.Literals<readonly ["read", "permissions", "parse"]>