Ephemeris option reference

Commit author email of the account. Used for release proposals, release tags and Renovate commits.

Type: null or attribute-tagged union with choices: environment, file, first, literal, secret, variable

Default:

null

Declared by:

Read the value from this environment variable at runtime.

Type: string

Declared by:

Read the path from this expression, then read the value from that file.

Type: expression

Declared by:

Use the first expression that has a value.

Type: list of (expression)

Default:

[ ]

Declared by:

Use this text as the value.

Type: string

Declared by:

Read the value from this forge Actions secret. The workflow exports it as an environment variable of the same name.

Type: string

Declared by:

Read the value from this forge Actions variable. The workflow exports it as an environment variable of the same name.

Type: string

Declared by:

User name of the account Ephemeris acts as. Used as the registry login on OCI pushes. Needed when OCI artifacts exist.

Type: null or attribute-tagged union with choices: environment, file, first, literal, secret, variable

Default:

null

Declared by:

Read the value from this environment variable at runtime.

Type: string

Declared by:

Read the path from this expression, then read the value from that file.

Type: expression

Declared by:

Use the first expression that has a value.

Type: list of (expression)

Default:

[ ]

Declared by:

Use this text as the value.

Type: string

Declared by:

Read the value from this forge Actions secret. The workflow exports it as an environment variable of the same name.

Type: string

Declared by:

Read the value from this forge Actions variable. The workflow exports it as an environment variable of the same name.

Type: string

Declared by:

Commit author name of the account. Used for release proposals, release tags and Renovate commits.

Type: null or attribute-tagged union with choices: environment, file, first, literal, secret, variable

Default:

null

Declared by:

Read the value from this environment variable at runtime.

Type: string

Declared by:

Read the path from this expression, then read the value from that file.

Type: expression

Declared by:

Use the first expression that has a value.

Type: list of (expression)

Default:

[ ]

Declared by:

Use this text as the value.

Type: string

Declared by:

Read the value from this forge Actions secret. The workflow exports it as an environment variable of the same name.

Type: string

Declared by:

Read the value from this forge Actions variable. The workflow exports it as an environment variable of the same name.

Type: string

Declared by:

Actions that workflows use, with a pinned commit and the generated inputs and outputs.

Type: attribute set of (submodule)

Default:

{ }

Declared by:

The generated inputs and outputs of the action, read from its action.yml. They apply while the pin of the data names the repository and path of the source, whatever the digest.

Type: attribute set

Default:

{
  inputs = { };
  outputs = { };
}

Declared by:

Inputs of an action without generated data, by camelCase name. They have the shape of the generated inputs.

Type: attribute set of (submodule)

Default:

{ }

Declared by:

The default value of the input.

Type: null or string

Default:

null

Declared by:

What the input does.

Type: string

Default:

""

Declared by:

The name of the input in the workflow.

Type: string

Default: the attribute name

Declared by:

Whether a step must set the input.

Type: boolean

Default:

false

Declared by:

Outputs of an action without generated data, by camelCase name. They have the shape of the generated outputs.

Type: attribute set of (submodule)

Default:

{ }

Declared by:

What the output holds.

Type: string

Default:

""

Declared by:

The name of the output in the workflow.

Type: string

Default: the attribute name

Declared by:

The pinned commit. Required for a repository source.

Type: null or string

Default:

null

Example:

"11bd71901bbe5b1630ceea73d27597364c9af683"

Declared by:

Inputs by original name that every step renders with this value. Steps cannot set them.

Type: attribute set of string

Default:

{ }

Example:

{
  persist-credentials = "false";
}

Declared by:

Option types of inputs by camelCase name. Inputs are strings by default. Steps lower bools and numbers to strings.

Type: attribute set of optionType

Default:

{ }

Example:

{ fetchDepth = lib.types.int; }

Declared by:

The inputs of the action by camelCase name, with the original name, description, required and default. Empty for local actions and actions without generated data or declared inputs.

Type: attribute set of (attribute set) (read only)

Default: generated from the pinned action.yml, plus declaredInputs

Declared by:

Push mirrors of the repository. The pinned commit exists on each of them.

Type: list of (submodule)

Default:

[ ]

Declared by:

The forge software of the host. Inferred for github.com and codeberg.org, required for other hosts.

Type: one of “github”, “forgejo”

Default: inferred for github.com and codeberg.org

Declared by:

The repository name with its owner, in the form owner/name.

Type: string (read only)

Default:

"${owner}/${name}"

Declared by:

The host name of the forge. Defaults to github.com when forge is github, otherwise required.

Type: string

Default: github.com when forge is github

Declared by:

The name of the repository.

Type: string

Declared by:

The user or organization that owns the repository.

Type: string

Declared by:

The repository web URL.

Type: string (read only)

Default:

"https://${host}/${owner}/${name}"

Declared by:

The outputs of the action by camelCase name, with the original name, description and ref. ref takes a step id and returns the expression body steps.<id>.outputs.<name>. Empty for local actions and actions without generated data or declared outputs.

Type: attribute set of (attribute set) (read only)

Default: generated from the pinned action.yml, plus declaredOutputs

Declared by:

Where the action comes from, a repository with an optional path, or a local path.

Type: submodule

Declared by:

A path in the checked out repository.

Type: null or string

Default:

null

Example:

"./.github/actions/setup"

Declared by:

The directory of the action in the repository. Null for the repository root.

Type: null or string

Default:

null

Example:

"restore"

Declared by:

The repository that holds the action.

Type: null or (submodule)

Default:

null

Declared by:

The forge software of the host. Inferred for github.com and codeberg.org, required for other hosts.

Type: one of “github”, “forgejo”

Default: inferred for github.com and codeberg.org

Declared by:

The repository name with its owner, in the form owner/name.

Type: string (read only)

Default:

"${owner}/${name}"

Declared by:

The host name of the forge. Defaults to github.com when forge is github, otherwise required.

Type: string

Default: github.com when forge is github

Declared by:

The name of the repository.

Type: string

Declared by:

The user or organization that owns the repository.

Type: string

Declared by:

The repository web URL.

Type: string (read only)

Default:

"https://${host}/${owner}/${name}"

Declared by:

The uses string for the forge of ephemeris.repository.remote.

Type: string (read only)

Default: the source rendered for ephemeris.repository.remote

Declared by:

Renders the uses string for a forge, github or forgejo. GitHub renders owner/name[/path]@digest from the first GitHub repository of the source and the mirrors. Forgejo renders the URL of the source repository.

Type: function that evaluates to a(n) string (read only)

Default: renders the source for a forge

Declared by:

The tag of the pinned commit.

Type: null or string

Default:

null

Example:

"v4.2.2"

Declared by:

Name of the ephemeris.credentials entry that authenticates the fetch of the baseline for checks with requiresBaseline. The runner fetches the baseline once and gives the token to that fetch only. Null runs a plain git fetch.

Type: null or string

Default:

null

Declared by:

Helm charts kept in the repository.

Type: attribute set of (submodule)

Default:

{ }

Declared by:

Values files relative to the repository root. Each is passed as --values to helm lint.

Type: list of string

Default:

[ ]

Declared by:

Chart directory relative to the repository root.

Type: string

Default:

"charts/${name}"

Declared by:

Release unit that publishes the chart as an OCI artifact.

Type: null or string

Default:

null

Declared by:

OCI repository path of the chart under the registry.

Type: string

Default:

"charts/${name}"

Declared by:

Whether to enable the generated checks workflow.

Type: boolean

Default:

false

Example:

true

Declared by:

Whether to enable pull request comments with the check results. Needs the gate job.

Type: boolean

Default:

false

Example:

true

Declared by:

Whether to add a Gate job that fails unless the checks job succeeds. On by default.

Type: boolean

Default:

true

Declared by:

Workflow name. The workflow key is the lower case name with dashes for spaces.

Type: string

Default:

"Checks"

Declared by:

Name of the Forgejo branch rule and GitHub ruleset that require the gate job. The gate job must be enabled.

Type: null or string

Default:

null

Example:

"main"

Declared by:

Named checks shared by local Nix evaluation and checkout-based CI.

Type: attribute set of (submodule)

Default:

{ }

Declared by:

Whether this check participates in local and CI selection.

Type: boolean

Default:

true

Declared by:

Optional command that returns 0 when this check applies, 1 when it should be skipped, and another status when applicability could not be determined.

Type: null or string

Default:

null

Declared by:

Default EPHEMERIS_BASELINE_REF for this check when the caller has not set one.

Type: null or string

Default:

null

Declared by:

Credential-free check command.

Type: string

Declared by:

Whether the check can run in Nix’s pure check environment or requires a source checkout.

Type: one of “pure”, “checkout”

Default:

"pure"

Declared by:

How the native output of the command becomes report details. format is junit, clippy or diff. source is "stdout" or { file = "<path>"; }, relative to the working directory of the check. The check state holds null or { format, source }, where source is the string stdout or { file }.

Type: null or (submodule)

Default:

null

Declared by:

The converter that turns the native output into report details.

Type: one of “junit”, “clippy”, “diff”

Declared by:

Where the native output is, either stdout or an attribute set with file.

Type: value “stdout” (singular enum) or (submodule)

Declared by:

Fail with an actionable error when EPHEMERIS_BASELINE_REF is unavailable.

Type: boolean

Default:

false

Declared by:

Processes of perSystem.ephemeris.processes that run while the check runs, with everything they run after.

Type: list of string

Default:

[ ]

Declared by:

Repository-relative working directory for this check.

Type: string

Default:

"."

Declared by:

Whether to enable commit message checking in the Scoped Commits or Conventional Commits format.

Type: boolean

Default:

false

Example:

true

Declared by:

Options for the Conventional Commits format.

Type: submodule

Default:

{ }

Declared by:

Whether a Conventional Commit subject may have a scope.

Type: boolean

Default:

true

Declared by:

Allowed Conventional Commit scopes. An empty list permits any scope.

Type: list of string

Default:

[ ]

Declared by:

Allowed Conventional Commit types. An empty list permits any type.

Type: list of string

Default:

[ ]

Declared by:

Python regular expression matching the commit description.

Type: string

Default:

"\\S.*"

Declared by:

Commit message format to enforce.

Type: one of “scoped”, “conventional”

Default:

if config.ephemeris.release.enable then "conventional" else "scoped"

Declared by:

Options for the scoped commit format.

Type: submodule

Default:

{ }

Declared by:

Allowed scoped commit scopes. An empty list permits any scope.

Type: list of string

Default:

[ ]

Declared by:

Python regular expression matching a scoped commit scope.

Type: string

Default:

"[^:\\n]+"

Declared by:

Named credentials. Each is a list of sources the CLI tries in order at runtime. The first source with its inputs present wins. The forge credential is the forge token for the repository, release and pull request workflows.

Type: attribute set of non-empty (list of attribute-tagged union with choices: forgejoIdToken, githubApp, value)

Default:

{ }

Example:

{ forge = [ { value.secret = "FORGE_TOKEN"; } { value.environment = "FORGE_TOKEN"; } ]; }

Declared by:

Exchange a Forgejo Actions ID token for an access token.

Type: submodule

Declared by:

Expression for the audience to request the Forgejo ID token for. Forgejo only. Needs openidConnect on the job.

Type: attribute-tagged union with choices: environment, file, first, literal, secret, variable

Declared by:

Read the value from this environment variable at runtime.

Type: string

Declared by:

Read the path from this expression, then read the value from that file.

Type: expression

Declared by:

Use the first expression that has a value.

Type: list of (expression)

Default:

[ ]

Declared by:

Use this text as the value.

Type: string

Declared by:

Read the value from this forge Actions secret. The workflow exports it as an environment variable of the same name.

Type: string

Declared by:

Read the value from this forge Actions variable. The workflow exports it as an environment variable of the same name.

Type: string

Declared by:

Exchange a GitHub App private key for an installation token scoped to this repository.

Type: submodule

Declared by:

Expression for the numeric App id. GitHub only.

Type: attribute-tagged union with choices: environment, file, first, literal, secret, variable

Declared by:

Read the value from this environment variable at runtime.

Type: string

Declared by:

Read the path from this expression, then read the value from that file.

Type: expression

Declared by:

Use the first expression that has a value.

Type: list of (expression)

Default:

[ ]

Declared by:

Use this text as the value.

Type: string

Declared by:

Read the value from this forge Actions secret. The workflow exports it as an environment variable of the same name.

Type: string

Declared by:

Read the value from this forge Actions variable. The workflow exports it as an environment variable of the same name.

Type: string

Declared by:

Expression for the App private key in PEM form. GitHub only.

Type: attribute-tagged union with choices: environment, file, first, literal, secret, variable

Declared by:

Read the value from this environment variable at runtime.

Type: string

Declared by:

Read the path from this expression, then read the value from that file.

Type: expression

Declared by:

Use the first expression that has a value.

Type: list of (expression)

Default:

[ ]

Declared by:

Use this text as the value.

Type: string

Declared by:

Read the value from this forge Actions secret. The workflow exports it as an environment variable of the same name.

Type: string

Declared by:

Read the value from this forge Actions variable. The workflow exports it as an environment variable of the same name.

Type: string

Declared by:

Use the value of this expression.

Type: attribute-tagged union with choices: environment, file, first, literal, secret, variable

Declared by:

Read the value from this environment variable at runtime.

Type: string

Declared by:

Read the path from this expression, then read the value from that file.

Type: expression

Declared by:

Use the first expression that has a value.

Type: list of (expression)

Default:

[ ]

Declared by:

Use this text as the value.

Type: string

Declared by:

Read the value from this forge Actions secret. The workflow exports it as an environment variable of the same name.

Type: string

Declared by:

Read the value from this forge Actions variable. The workflow exports it as an environment variable of the same name.

Type: string

Declared by:

Whether to enable the generated .envrc.

Type: boolean

Default:

false

Example:

true

Declared by:

Repository-relative paths direnv watches, so it reloads the environment when they change.

Type: list of string

Default:

[
  "ephemeris.nix"
]

Declared by:

Widest key = { ... } line in columns that stays an inline table in rendered TOML.

Type: positive integer, meaning >0

Default:

80

Declared by:

Repository files managed by Ephemeris.

Type: attribute set

Default:

{ }

Declared by:

Generated code, keyed by name. Each entry adds the check generated-<name> and the package generate-<name>.

Type: attribute set of (submodule)

Default:

{ }

Declared by:

Whether the generator can run in Nix’s pure check environment or needs a source checkout.

Type: one of “pure”, “checkout”

Default:

"pure"

Declared by:

Repository-relative paths the generator reads. They order the generators and limit when the check applies.

Type: list of string

Default:

[ ]

Example:

[
  "migrations"
]

Declared by:

Files and directories the generator writes, keyed by repository-relative path. An output is a tree unless kind is exact, like ephemeris.paths. Ephemeris leaves them unmanaged. An entry without outputs has no check unless verify is set.

Type: attribute set of (submodule)

Default:

{ }

Example:

{
  "Cargo.lock".kind = "exact";
  "packages/server-db" = { };
}

Declared by:

exact selects a file or symlink leaf; tree selects a path and its descendants.

Type: one of “exact”, “tree”

Default:

"tree"

Declared by:

Processes of perSystem.ephemeris.processes that run while the generator runs, with everything they run after.

Type: list of string

Default:

[ ]

Declared by:

A command, run from the repository root, that fails when the outputs are stale. When set, the check runs it instead of regenerating and comparing.

Type: null or string

Default:

null

Example:

"npm ci --dry-run --offline"

Declared by:

Whether to enable the generated .gitattributes.

Type: boolean

Default:

false

Example:

true

Declared by:

Direct gitattributes lines appended after the generated lines and the rules, so a later line can unmark a path. Use them for macros, custom attributes and anything rules does not model.

Type: list of string

Default:

[ ]

Declared by:

Typed attribute rules, rendered in order after the generated lines. Git uses the last matching line, so order matters.

Type: list of (submodule)

Default:

[ ]

Declared by:

Set the binary macro.

Type: boolean

Default:

false

Declared by:

Length of conflict markers.

Type: null or (positive integer, meaning >0)

Default:

null

Declared by:

False renders -delta.

Type: null or boolean

Default:

null

Declared by:

True renders diff, false renders -diff and a string names the driver.

Type: null or boolean or string

Default:

null

Declared by:

Line ending in the working tree.

Type: null or one of “lf”, “crlf”

Default:

null

Declared by:

Leave the path out of git archive. Forge source archives drop it and Nix tarball fetchers such as github: read the archive, so never set this on a file the flake needs.

Type: boolean

Default:

false

Declared by:

Expand $Format:...$ placeholders in git archive.

Type: boolean

Default:

false

Declared by:

Filter driver, for example lfs.

Type: null or string

Default:

null

Declared by:

Attributes that Forgejo and GitHub read for diffs and language statistics.

Type: submodule

Default:

{ }

Declared by:

Include the path in language statistics.

Type: null or boolean

Default:

null

Declared by:

Treat the path as documentation.

Type: null or boolean

Default:

null

Declared by:

Fold the path in diffs and leave it out of language statistics.

Type: null or boolean

Default:

null

Declared by:

Language of the path, for example Markdown.

Type: null or string

Default:

null

Declared by:

Treat the path as vendored code.

Type: null or boolean

Default:

null

Declared by:

True renders merge, false renders -merge and a string names the driver.

Type: null or boolean or string

Default:

null

Declared by:

The gitattributes pattern, written as given.

Type: string

Declared by:

True renders text, false renders -text and "auto" renders text=auto.

Type: null or boolean or value “auto” (singular enum)

Default:

null

Declared by:

Whitespace checks, for example trailing-space.

Type: null or string

Default:

null

Declared by:

Encoding in the working tree, for example UTF-16.

Type: null or string

Default:

null

Declared by:

Whether to enable the generated .gitignore.

Type: boolean

Default:

false

Example:

true

Declared by:

Direct Gitignore syntax appended in order after generated policy patterns.

Type: list of string

Default:

[ ]

Declared by:

Whether to enable the calf-granary build cache in generated workflows.

Type: boolean

Default:

false

Example:

true

Declared by:

The audience granary expects in ID tokens.

Type: string

Default:

"calf-granary"

Declared by:

The granary server URL.

Type: string

Example:

"https://granary.example.org"

Declared by:

Container images built from flake packages.

Type: attribute set of (submodule)

Default:

{ }

Declared by:

Per-system package copied into the image.

Type: string

Declared by:

Image entrypoint. Elements starting with bin/ resolve against the package output.

Type: list of string

Default:

[ "bin/<name>" ]

Declared by:

Image environment variables.

Type: attribute set of string

Default:

{ }

Declared by:

OCI platforms to build the image for. Each platform takes the static target package of the Rust workspace member package for that platform. Empty builds package for the host platform only.

Type: list of string matching the pattern [a-z0-9]+/[a-z0-9]+

Default:

[ ]

Example:

[
  "linux/amd64"
  "linux/arm64"
]

Declared by:

Exposed ports.

Type: list of string

Default:

[ ]

Example:

[
  "8080/tcp"
]

Declared by:

Whether publication also pushes the latest tag.

Type: boolean

Default:

false

Declared by:

Release unit that publishes this image as an OCI artifact.

Type: null or string

Default:

null

Declared by:

Repository path the image is pushed to.

Type: string

Default:

<name>

Declared by:

User the image runs as. The image runs as root when null.

Type: null or (submodule)

Default:

null

Declared by:

Numeric group id.

Type: unsigned integer, meaning >=0

Declared by:

User and group name in /etc/passwd and /etc/group.

Type: string

Declared by:

Numeric user id.

Type: unsigned integer, meaning >=0

Declared by:

Whether to enable generated license files.

Type: boolean

Default:

false

Example:

true

Declared by:

Typed license text descriptors keyed by SPDX identifier. Consumers may extend or override entries.

Type: attribute set of (submodule)

Default:

{
  "AGPL-3.0-only" = {
    files = [
      {
        filename = null;
        readme = {
          label = "GNU Affero General Public License v3.0 only";
          url = "https://www.gnu.org/licenses/agpl-3.0.html";
        };
        source = /nix/store/ybr9vvj07b63aw391r76g33v25qc8m8i-source/nix/features/license/data/AGPL-3.0.txt;
      }
    ];
  };
  "AGPL-3.0-or-later" = {
    files = [
      {
        filename = null;
        readme = {
          label = "GNU Affero General Public License v3.0 or later";
          url = "https://www.gnu.org/licenses/agpl-3.0.html";
        };
        source = /nix/store/ybr9vvj07b63aw391r76g33v25qc8m8i-source/nix/features/license/data/AGPL-3.0.txt;
      }
    ];
  };
  "Apache-2.0" = {
    files = [
      {
        choiceFilename = "LICENSE-APACHE";
        filename = null;
        readme = {
          label = "Apache License, Version 2.0";
          url = "https://www.apache.org/licenses/LICENSE-2.0";
        };
        source = /nix/store/ybr9vvj07b63aw391r76g33v25qc8m8i-source/nix/features/license/data/Apache-2.0.txt;
      }
    ];
  };
  MIT = {
    files = [
      {
        choiceFilename = "LICENSE-MIT";
        filename = null;
        readme = {
          label = "MIT license";
          url = "https://opensource.org/licenses/MIT";
        };
        source = /nix/store/ybr9vvj07b63aw391r76g33v25qc8m8i-source/nix/features/license/data/MIT.txt;
        substitutions = [
          {
            from = "Copyright (c) <year> <copyright holders>";
            to = "Copyright (c) INOMO Technologies AG";
          }
        ];
      }
    ];
  };
}

Declared by:

Texts and generated names for this SPDX license.

Type: list of (submodule)

Default:

[ ]

Declared by:

Filename used when this descriptor is one of multiple selected licenses.

Type: null or string

Default:

null

Declared by:

Generated filename override; defaults to LICENSE for one license and LICENSE-SPDX-ID for a choice.

Type: null or string

Default:

null

Declared by:

Optional reference shown with the license in the README.

Type: null or (submodule)

Default:

null

Declared by:

This option has no description.

Type: string

Declared by:

This option has no description.

Type: string

Declared by:

Local path of the license text.

Type: absolute path

Declared by:

Literal replacements applied to this text.

Type: list of (submodule)

Default:

[ ]

Declared by:

This option has no description.

Type: string

Declared by:

Replacement text, or null when supplied by the selected project configuration.

Type: null or string

Default:

null

Declared by:

Whether to enable deployment to Codeberg Pages or GitHub Pages.

Type: boolean

Default:

false

Example:

true

Declared by:

The public URL of the published site. Null when there is no remote repository or no Forgejo pages domain.

Type: null or string (read only)

Default:

the public URL of the published site

Declared by:

Path rules that set source, ignore, managed, and format with a priority each. Build entries with ephemeris.lib.paths.rule.

Type: list of (attribute set)

Default:

[ ]

Declared by:

Literal repository-relative paths. Keys are never glob syntax. Set managed to require that tracked files there are generated or carry the generated header.

Type: attribute set of (submodule)

Default:

{ }

Declared by:

Whether formatters process files here. Set false to exclude them.

Type: null or boolean

Default:

null

Declared by:

This option has no description.

Type: null or boolean

Default:

null

Declared by:

exact selects a file or symlink leaf; tree selects a path and its descendants.

Type: one of “exact”, “tree”

Default:

"tree"

Declared by:

Whether tracked files here must be generated or carry the generated header. Other files make files apply fail.

Type: null or boolean

Default:

null

Declared by:

This option has no description.

Type: null or boolean

Default:

null

Declared by:

The complete copyright notice to use in an MIT license.

Type: null or string

Default:

null

Declared by:

A short description of the repository. Null declares none.

Type: null or string

Default:

null

Declared by:

The Nixpkgs license record, or alternative records, used by the project. Null declares none.

Type: null or (open submodule of (attribute set)) or list of (open submodule of (attribute set))

Default:

null

Declared by:

The SPDX license expression derived from ephemeris.project.license. Null when no license is declared.

Type: null or string

Default:

lib.concatMapStringsSep " OR " (license: license.spdxId) (lib.toList config.ephemeris.project.license)

Declared by:

The repository’s human-readable project name. Null declares none.

Type: null or string

Default:

null

Declared by:

The project title used in headings. Defaults to the name verbatim.

Type: null or string

Default:

config.ephemeris.project.name

Declared by:

Whether to enable the managed README.

Type: boolean

Default:

false

Example:

true

Declared by:

The introductory Markdown text below the README heading.

Type: string

Default:

""

Declared by:

Public documentation URL rendered in whole mode. The project feature defaults it to the pages URL when pages are published.

Type: null or string

Default:

null

Declared by:

Whether whole mode renders a license section.

Type: boolean

Default:

false

Declared by:

Whether Ephemeris manages the whole README or selected regions. Only used when enable is true.

Type: one of “whole”, “partial”

Default:

"whole"

Declared by:

Ordered README sections rendered in whole mode.

Type: list of (attribute set)

Default:

[ ]

Declared by:

Additional selected regions managed when mode is partial.

Type: list of (attribute set)

Default:

[ ]

Declared by:

The README heading.

Type: string

Declared by:

Whether to enable independent package release orchestration.

Type: boolean

Default:

false

Example:

true

Declared by:

Publication artifacts grouped by release unit.

Type: attribute set of attribute set of attribute-tagged union with choices: asset, cargo, npm, oci

Default:

{ }

Declared by:

A file from a package output, uploaded to the forge release.

Type: submodule

Declared by:

Per-system package output containing this artifact.

Type: string

Declared by:

Publication filename for the artifact.

Type: string

Declared by:

Publication format, such as deb.

Type: string

Declared by:

Path relative to the selected package output.

Type: string

Declared by:

Names that publication must expose for this artifact.

Type: list of string

Default:

[ ]

Declared by:

Artifact variant identifier.

Type: string

Default:

""

Declared by:

A crate file uploaded to the Cargo registry.

Type: submodule

Declared by:

Per-system package whose output holds exactly one .crate file at its root.

Type: string

Declared by:

A package tarball published to the npm registry.

Type: submodule

Declared by:

Per-system package whose output holds exactly one .tgz file at its root.

Type: string

Declared by:

A package whose bin/push program pushes to an OCI registry.

Type: submodule

Declared by:

Per-system package whose output has a bin/push program.

Type: string

Declared by:

Whether the moving latest tag is pushed too.

Type: boolean

Default:

false

Declared by:

OCI registry and namespace to push to.

Type: null or string

Default:

config.ephemeris.release.oci.registry

Declared by:

Repository path under the registry.

Type: string

Declared by:

Merged branch from which publication is permitted.

Type: string

Default:

"main"

Declared by:

Derive one release unit per Cargo workspace member.

Type: boolean

Default:

false

Declared by:

Optional named Cargo registry used for release publication.

Type: null or string

Default:

null

Declared by:

Cargo registry API base URL used to upload and check published crates. Required when a Cargo unit publishes.

Type: null or string

Default:

null

Declared by:

Commit message format that the release proposal derives version bumps and changelog entries from. Null derives nothing from commits.

Type: null or value “conventional” (singular enum)

Default:

if config.ephemeris.commitMessage.enable && config.ephemeris.commitMessage.format == "conventional"
then "conventional" else null

Declared by:

Subject template of the release proposal commits, one per release unit. It must contain {version} and may contain {unit}. A commit that covers several units names them all, separated by commas. The subject must satisfy the configured commit message policy.

Type: string

Default:

"release: {unit} {version}"

Declared by:

Name of the ephemeris.credentials entry that uploads packages and logs in to OCI registries.

Type: string

Default:

"forge"

Declared by:

The Forgejo tag protection declared for the tag prefix of every release unit. Null declares none.

Type: null or (submodule)

Default:

null

Declared by:

Teams who may create release tags.

Type: list of string

Default:

[ ]

Declared by:

Users who may create release tags.

Type: list of string

Default:

[ ]

Declared by:

The GitHub tag ruleset declared for the tag prefix of every release unit. Null declares none.

Type: null or (submodule)

Default:

null

Declared by:

Actors that may create, move and delete release tags.

Type: list of (submodule)

Default:

[ ]

Declared by:

The actor id. Required for repository roles, teams and users. Null on an integration means the App Ephemeris acts as. Must be null for deploy keys. Organization admins need none.

Type: null or signed integer

Default:

null

Declared by:

The kind of actor that may bypass the ruleset.

Type: one of “Integration”, “OrganizationAdmin”, “RepositoryRole”, “Team”, “User”, “DeployKey”

Declared by:

When the actor may bypass the ruleset.

Type: one of “always”, “pull_request”, “exempt”

Default:

"always"

Declared by:

npm registry URL used for release publication, such as https://codeberg.org/api/packages/example/npm/.

Type: null or string

Default:

null

Declared by:

Default OCI registry and namespace for oci artifacts, such as codeberg.org/example.

Type: null or string

Default:

null

Declared by:

Maintained release proposal branch.

Type: string

Default:

"ephemeris/release"

Declared by:

Independently versioned release units and their dependency graph.

Type: attribute set of (submodule)

Default:

{ }

Declared by:

Default automatic version bump for an application release proposal.

Type: one of “patch”, “none”

Default:

"patch"

Declared by:

Repository changelog path for this release unit. Null keeps no changelog.

Type: null or string

Default:

if builtins.dirOf targetPath == "." then "CHANGELOG.md"
else "${builtins.dirOf targetPath}/CHANGELOG.md"

Declared by:

Release units that must be published first.

Type: list of string

Default:

[ ]

Declared by:

Files of this unit that hold the version of a dependency, keyed by dependency unit. The proposal rewrites them when the dependency releases.

Type: attribute set of (submodule)

Default:

{ }

Declared by:

Files of this unit that hold the SHA256 of an asset artifact of the dependency, keyed by artifact. The proposal builds the asset and writes its digest when the unit itself gets a new version.

Type: attribute set of (submodule)

Default:

{ }

Declared by:

The hash algorithm of the digest, written as lowercase hex.

Type: one of “sha256”, “sha512”

Declared by:

Key path to the digest string inside the file.

Type: non-empty (list of string)

Default:

[
  "digest"
]

Declared by:

TOML, YAML or JSON file holding the digest of the asset, relative to the repository root.

Type: string

Declared by:

Key path to the version string inside the file.

Type: non-empty (list of string)

Default:

[
  "version"
]

Declared by:

TOML, YAML or JSON file holding the dependency version, relative to the repository root.

Type: string

Declared by:

Optional repository-relative decimal packaging revision file.

Type: null or string

Default:

null

Declared by:

Repository directories whose changes trigger this release unit.

Type: list of string

Default:

[
  (builtins.dirOf (
    if target ? cargo then target.cargo.manifest
    else if target ? npm then target.npm.manifest
    else if target ? versionFile then target.versionFile.path
    else target.document.path
  ))
]

Declared by:

Prefix for package-specific release tags.

Type: string

Default:

"‹name›-v"

Declared by:

Version source and publication ecosystem for this release unit.

Type: attribute-tagged union with choices: cargo, document, npm, versionFile

Declared by:

This option has no description.

Type: submodule

Declared by:

Whether this unit follows library semver analysis or application bump policy.

Type: one of “library”, “application”

Default:

"library"

Declared by:

Cargo manifest, relative to the repository root.

Type: string

Declared by:

Whether the Cargo package is published to a registry.

Type: boolean

Default:

true

Declared by:

This option has no description.

Type: submodule

Declared by:

Key path to the version string inside the document.

Type: non-empty (list of string)

Default:

[
  "version"
]

Declared by:

TOML, YAML or JSON file holding the version, relative to the repository root.

Type: string

Declared by:

This option has no description.

Type: submodule

Declared by:

package.json of the package, relative to the repository root.

Type: string

Declared by:

Whether the npm package is published to a registry.

Type: boolean

Default:

true

Declared by:

This option has no description.

Type: submodule

Declared by:

Repository file containing the version updated by this release unit.

Type: string

Declared by:

Whether to enable the generated release workflow.

Type: boolean

Default:

false

Example:

true

Declared by:

Whether to enable Renovate dependency updates.

Type: boolean

Default:

false

Example:

true

Declared by:

Post-upgrade commands that the workflow allows besides the reconcile commands. Features add their own.

Type: list of string

Default:

[ ]

Declared by:

The Renovate repository configuration. Every option comes from the configuration schema of the pinned Renovate. Unset options stay out of the file.

Type: submodule

Default:

{ }

Declared by:

Enable or disable corresponding functionality. See also: https://docs.renovatebot.com/configuration-options/#enabled

Renovate default: true

Type: null or boolean

Default:

null

Declared by:

A list of package managers to enable. Only managers on the list are enabled. See also: https://docs.renovatebot.com/configuration-options/#enabledmanagers

Type: null or (list of string)

Default:

null

Declared by:

Rules for matching packages. See also: https://docs.renovatebot.com/configuration-options/#packagerules

Type: null or (list of (submodule))

Default:

null

Declared by:

Flags packages that have not been updated within this period as abandoned. See also: https://docs.renovatebot.com/configuration-options/#abandonmentthreshold

Renovate default: null

Type: null or (explicit JSON null, written as `{ jsonNull = true; }`) or string

Default:

null

Declared by:

Labels to add to Pull Request. See also: https://docs.renovatebot.com/configuration-options/#addlabels

Type: null or (list of string)

Default:

null

Declared by:

Additional string value to be appended to branchPrefix. See also: https://docs.renovatebot.com/configuration-options/#additionalbranchprefix

Renovate default: ""

Type: null or string

Default:

null

Declared by:

Additional reviewers for Pull Requests (in contrast to reviewers, this option adds to the existing reviewer list, rather than replacing it). See also: https://docs.renovatebot.com/configuration-options/#additionalreviewers

Type: null or (list of string)

Default:

null

Declared by:

Configuration object for the ansible manager See also: https://docs.renovatebot.com/configuration-options/#ansible

Renovate default: {"managerFilePatterns":["/(^|/)tasks/[^/]+\\.ya?ml$/"]}

Type: null or (submodule)

Default:

null

Declared by:

Configuration object for the ansible-galaxy manager See also: https://docs.renovatebot.com/configuration-options/#ansible-galaxy

Renovate default: {"managerFilePatterns":["/(^|/)(galaxy|requirements)(\\.ansible)?\\.ya?ml$/"]}

Type: null or (submodule)

Default:

null

Declared by:

Configuration object for the ant manager See also: https://docs.renovatebot.com/configuration-options/#ant

Renovate default: {"managerFilePatterns":["**/build.xml"]}

Type: null or (submodule)

Default:

null

Declared by:

Configuration object for the apm manager See also: https://docs.renovatebot.com/configuration-options/#apm

Renovate default: {"managerFilePatterns":["/(^|/)apm\\.ya?ml$/"]}

Type: null or (submodule)

Default:

null

Declared by:

Configuration object for the argocd manager See also: https://docs.renovatebot.com/configuration-options/#argocd

Renovate default: {"managerFilePatterns":[]}

Type: null or (submodule)

Default:

null

Declared by:

Configuration object for the asdf manager See also: https://docs.renovatebot.com/configuration-options/#asdf

Renovate default: {"managerFilePatterns":["/(^|/)\\.tool-versions$/"]}

Type: null or (submodule)

Default:

null

Declared by:

Assign reviewers and assignees even if the PR is to be automerged. See also: https://docs.renovatebot.com/configuration-options/#assignautomerge

Renovate default: false

Type: null or boolean

Default:

null

Declared by:

Assignees for Pull Request (either username or email address depending on the platform). See also: https://docs.renovatebot.com/configuration-options/#assignees

Type: null or (list of string)

Default:

null

Declared by:

Determine assignees based on configured code owners and changes in PR. See also: https://docs.renovatebot.com/configuration-options/#assigneesfromcodeowners

Renovate default: false

Type: null or boolean

Default:

null

Declared by:

Take a random sample of given size from assignees. See also: https://docs.renovatebot.com/configuration-options/#assigneessamplesize

Renovate default: null

Type: null or (explicit JSON null, written as `{ jsonNull = true; }`) or signed integer

Default:

null

Declared by:

Set to true to automatically approve PRs. See also: https://docs.renovatebot.com/configuration-options/#autoapprove

Renovate default: false

Type: null or boolean

Default:

null

Declared by:

Control whether replacement regular expressions are global matches or only the first match. See also: https://docs.renovatebot.com/configuration-options/#autoreplaceglobalmatch

Renovate default: true

Type: null or boolean

Default:

null

Declared by:

Whether to automerge branches/PRs automatically, without human intervention. See also: https://docs.renovatebot.com/configuration-options/#automerge

Renovate default: false

Type: null or boolean

Default:

null

Declared by:

PR comment to add to trigger automerge. Only used if automergeType=pr-comment. See also: https://docs.renovatebot.com/configuration-options/#automergecomment

Renovate default: "automergeComment"

Type: null or string

Default:

null

Declared by:

Limit automerge to these times of day or week. See also: https://docs.renovatebot.com/configuration-options/#automergeschedule

Renovate default: ["at any time"]

Type: null or (list of string) or string

Default:

null

Declared by:

The merge strategy to use when automerging PRs. Used only if automergeType=pr. See also: https://docs.renovatebot.com/configuration-options/#automergestrategy

Renovate default: "auto"

Type: null or one of “auto”, “fast-forward”, “merge-commit”, “rebase”, “rebase-merge”, “squash”

Default:

null

Declared by:

How to automerge, if enabled. See also: https://docs.renovatebot.com/configuration-options/#automergetype

Renovate default: "pr"

Type: null or one of “branch”, “pr”, “pr-comment”

Default:

null

Declared by:

Configuration object for the azure-pipelines manager See also: https://docs.renovatebot.com/configuration-options/#azure-pipelines

Renovate default: {"enabled":false,"managerFilePatterns":["/(^|/).azuredevops/.+\\.ya?ml$/","/azure.*pipelines?.*\\.ya?ml$/"]}

Type: null or (submodule)

Default:

null

Declared by:

The id of an existing work item on Azure Boards to link to each PR. See also: https://docs.renovatebot.com/configuration-options/#azureworkitemid

Renovate default: 0

Type: null or signed integer

Default:

null

Declared by:

The work item type Renovate uses for its issues (e.g. the Dependency Dashboard) on Azure DevOps. See also: https://docs.renovatebot.com/configuration-options/#azureworkitemtype

Renovate default: "Issue"

Type: null or string

Default:

null

Declared by:

List of one or more custom base branches defined as exact strings and/or via regex expressions. See also: https://docs.renovatebot.com/configuration-options/#basebranchpatterns

Type: null or (list of string)

Default:

null

Declared by:

Configuration object for the batect manager See also: https://docs.renovatebot.com/configuration-options/#batect

Renovate default: {"managerFilePatterns":["/(^|/)batect(-bundle)?\\.ya?ml$/"]}

Type: null or (submodule)

Default:

null

Declared by:

Configuration object for the batect-wrapper manager See also: https://docs.renovatebot.com/configuration-options/#batect-wrapper

Renovate default: {"managerFilePatterns":["/(^|/)batect$/"],"versioning":"semver"}

Type: null or (submodule)

Default:

null

Declared by:

Configuration object for the bazel manager See also: https://docs.renovatebot.com/configuration-options/#bazel

Renovate default: {"managerFilePatterns":["/(^|/)WORKSPACE(|\\.bazel|\\.bzlmod)$/","/\\.WORKSPACE\\.bazel$/","/\\.bzl$/"]}

Type: null or (submodule)

Default:

null

Declared by:

Configuration object for the bazel-module manager See also: https://docs.renovatebot.com/configuration-options/#bazel-module

Renovate default: {"managerFilePatterns":["/(^|/|\\.)MODULE\\.bazel$/"]}

Type: null or (submodule)

Default:

null

Declared by:

Configuration object for the bazelisk manager See also: https://docs.renovatebot.com/configuration-options/#bazelisk

Renovate default: {"managerFilePatterns":["/(^|/)\\.bazelversion$/"],"pinDigests":false,"versioning":"semver"}

Type: null or (submodule)

Default:

null

Declared by:

The PR tasks will be automatically completed after the PR is raised. See also: https://docs.renovatebot.com/configuration-options/#bbautoresolveprtasks

Renovate default: false

Type: null or boolean

Default:

null

Declared by:

Use the default reviewers (Bitbucket only). See also: https://docs.renovatebot.com/configuration-options/#bbusedefaultreviewers

Renovate default: true

Type: null or boolean

Default:

null

Declared by:

Configuration object for the bicep manager See also: https://docs.renovatebot.com/configuration-options/#bicep

Renovate default: {"managerFilePatterns":["/\\.bicep$/"]}

Type: null or (submodule)

Default:

null

Declared by:

Configuration object for the bitbucket-pipelines manager See also: https://docs.renovatebot.com/configuration-options/#bitbucket-pipelines

Renovate default: {"managerFilePatterns":["**/*-pipelines.yml"]}

Type: null or (submodule)

Default:

null

Declared by:

Configuration object for the bitrise manager See also: https://docs.renovatebot.com/configuration-options/#bitrise

Renovate default: {"managerFilePatterns":["/(^|/)bitrise\\.ya?ml$/"]}

Type: null or (submodule)

Default:

null

Declared by:

Limit to a maximum of x concurrent branches. 0 means no limit, null (default) inherits value from prConcurrentLimit. See also: https://docs.renovatebot.com/configuration-options/#branchconcurrentlimit

Renovate default: null

Type: null or (explicit JSON null, written as `{ jsonNull = true; }`) or signed integer

Default:

null

Declared by:

Branch name template. See also: https://docs.renovatebot.com/configuration-options/#branchname

Renovate default: "{{{branchPrefix}}}{{{additionalBranchPrefix}}}{{{branchTopic}}}"

Type: null or string

Default:

null

Declared by:

Whether to be strict about the use of special characters within the branch name. See also: https://docs.renovatebot.com/configuration-options/#branchnamestrict

Renovate default: false

Type: null or boolean

Default:

null

Declared by:

Prefix to use for all branch names. See also: https://docs.renovatebot.com/configuration-options/#branchprefix

Renovate default: "renovate/"

Type: null or string

Default:

null

Declared by:

Old branchPrefix value to check for existing PRs. See also: https://docs.renovatebot.com/configuration-options/#branchprefixold

Renovate default: "renovate/"

Type: null or string

Default:

null

Declared by:

Branch topic. See also: https://docs.renovatebot.com/configuration-options/#branchtopic

Renovate default: "{{{depNameSanitized}}}-{{{newMajor}}}{{#if separateMinorPatch}}{{#if isPatch}}.{{{newMinor}}}{{/if}}{{/if}}{{#if separateMultipleMinor}}{{#if isMinor}}.{{{newMinor}}}{{/if}}{{/if}}.x{{#if isLockfileUpdate}}-lockfile{{/if}}"

Type: null or string

Default:

null

Declared by:

Configuration object for the buildkite manager See also: https://docs.renovatebot.com/configuration-options/#buildkite

Renovate default: {"commitMessageExtra":"to {{#if isMajor}}{{{prettyNewMajor}}}{{else}}{{{newValue}}}{{/if}}","commitMessageTopic":"buildkite plugin {{depName}}","managerFilePatterns":["/buildkite\\.ya?ml/","/\\.buildkite/.+\\.ya?ml$/"]}

Type: null or (submodule)

Default:

null

Declared by:

Configuration object for the buildpacks manager See also: https://docs.renovatebot.com/configuration-options/#buildpacks

Renovate default: {"commitMessageTopic":"buildpack {{depName}}","managerFilePatterns":["/(^|/)project\\.toml$/"],"pinDigests":false}

Type: null or (submodule)

Default:

null

Declared by:

Bump the version in the package file being updated. See also: https://docs.renovatebot.com/configuration-options/#bumpversion

Type: null or one of “major”, “minor”, “patch”, “prerelease”

Default:

null

Declared by:

A list of bumpVersion config options to bump generic version numbers. See also: https://docs.renovatebot.com/configuration-options/#bumpversions

Renovate default: []

Type: null or (list of (submodule))

Default:

null

Declared by:

Configuration object for the bun manager See also: https://docs.renovatebot.com/configuration-options/#bun

Renovate default: {"digest":{"prBodyDefinitions":{"Change":"{{#if displayFrom}}{{{displayFrom}}} → {{else}}{{#if currentValue}}{{{currentValue}}} → {{/if}}{{/if}}{{#if displayTo}}{{{displayTo}}}{{else}}{{{newValue}}}{{/if}}"}},"managerFilePatterns":["/(^|/)bun\\.lockb?$/","/(^|/)package\\.json$/"],"prBodyDefinitions":{"Change":"[{{#if displayFrom}}{{{displayFrom}}} → {{else}}{{#if currentValue}}{{{currentValue}}} → {{/if}}{{/if}}{{#if displayTo}}{{{displayTo}}}{{else}}{{{newValue}}}{{/if}}]({{#if depName}}https://renovatebot.com/diffs/npm/{{replace '/' '%2f' depName}}/{{{currentVersion}}}/{{{newVersion}}}{{/if}})"}}

Type: null or (submodule)

Default:

null

Declared by:

Configuration object for the bun-version manager See also: https://docs.renovatebot.com/configuration-options/#bun-version

Renovate default: {"managerFilePatterns":["/(^|/)\\.bun-version$/"],"versioning":"npm"}

Type: null or (submodule)

Default:

null

Declared by:

Configuration object for the bundler manager See also: https://docs.renovatebot.com/configuration-options/#bundler

Renovate default: {"managerFilePatterns":["/(^|/)Gemfile$/"],"versioning":"ruby"}

Type: null or (submodule)

Default:

null

Declared by:

Configuration object for the cake manager See also: https://docs.renovatebot.com/configuration-options/#cake

Renovate default: {"managerFilePatterns":["/\\.cake$/"]}

Type: null or (submodule)

Default:

null

Declared by:

Configuration object for the cargo manager See also: https://docs.renovatebot.com/configuration-options/#cargo

Renovate default: {"commitMessageTopic":"Rust crate {{depName}}","managerFilePatterns":["/(^|/)Cargo\\.toml$/"]}

Type: null or (submodule)

Default:

null

Declared by:

Configuration object for the cdnurl manager See also: https://docs.renovatebot.com/configuration-options/#cdnurl

Renovate default: {"managerFilePatterns":[],"versioning":"semver"}

Type: null or (submodule)

Default:

null

Declared by:

Configuration object for the circleci manager See also: https://docs.renovatebot.com/configuration-options/#circleci

Renovate default: {"managerFilePatterns":["/(^|/)\\.circleci/.+\\.ya?ml$/"]}

Type: null or (submodule)

Default:

null

Declared by:

Set to true to initialize submodules during repository clone. See also: https://docs.renovatebot.com/configuration-options/#clonesubmodules

Renovate default: false

Type: null or boolean

Default:

null

Declared by:

List of submodules names or patterns to clone when cloneSubmodules=true. See also: https://docs.renovatebot.com/configuration-options/#clonesubmodulesfilter

Renovate default: ["*"]

Type: null or (list of string)

Default:

null

Declared by:

Configuration object for the cloudbuild manager See also: https://docs.renovatebot.com/configuration-options/#cloudbuild

Renovate default: {"managerFilePatterns":["/(^|/)cloudbuild\\.ya?ml/"]}

Type: null or (submodule)

Default:

null

Declared by:

Configuration object for the cocoapods manager See also: https://docs.renovatebot.com/configuration-options/#cocoapods

Renovate default: {"managerFilePatterns":["/(^|/)Podfile$/"],"versioning":"ruby"}

Type: null or (submodule)

Default:

null

Declared by:

Commit message body template. Will be appended to commit message, separated by two line returns. See also: https://docs.renovatebot.com/configuration-options/#commitbody

Type: null or string

Default:

null

Declared by:

If enabled, append a table in the commit message body describing all updates in the commit. See also: https://docs.renovatebot.com/configuration-options/#commitbodytable

Renovate default: false

Type: null or boolean

Default:

null

Declared by:

Rate limit commits to maximum x per hour. 0 means no limit. See also: https://docs.renovatebot.com/configuration-options/#commithourlylimit

Renovate default: 0

Type: null or signed integer

Default:

null

Declared by:

Message to use for commit messages and pull request titles. See also: https://docs.renovatebot.com/configuration-options/#commitmessage

Renovate default: "{{{commitMessagePrefix}}} {{{commitMessageAction}}} {{{commitMessageTopic}}} {{{commitMessageExtra}}} {{{commitMessageSuffix}}}"

Type: null or string

Default:

null

Declared by: