stig-engine/com.stigway.engine.scm/CommitRef

CommitRef

Strategy for choosing the commit SHA used in generated source-browse links.

Rather than requiring an explicit commit string (which may go stale or point at an unpushed local commit), callers pick a resolution strategy and the tooling resolves it at generation time from the checkout's git state.

Entries

HEAD

Use the checkout's current HEAD commit. This is the default behavior for repos whose HEAD has been pushed to the remote.

PARENT

Use the commit that the remote default branch (origin/master or origin/main) points to — i.e. the last fetched commit on the remote before the local STIG analysis branch diverged.

Properties

entries

val entries: EnumEntries<CommitRef>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

val name: String

ordinal

val ordinal: Int

Functions

valueOf

fun valueOf(value: String): CommitRef

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<CommitRef>

Returns an array containing the constants of this enum type, in the order they're declared.