CIEnvironment class

Service responsible for detecting CI/CD execution environments.

Constructors

CIEnvironment([Map<String, String>? env])

Properties

actor → String?
Actor or user who triggered the run.
no setter
branch → String?
Target branch name (e.g. 'main', 'feature/foo').
no setter
commitSha → String?
Commit SHA hash.
no setter
eventName → String?
Event trigger name (e.g. 'push', 'pull_request', 'workflow_dispatch').
no setter
hashCode → int
The hash code for this object.
no setterinherited
isCi → bool
Whether running inside any CI environment.
no setter
isGitHubActions → bool
Whether running inside GitHub Actions.
no setter
providerName → String
CI provider name ('GitHub Actions', 'CI', or 'Local').
no setter
repository → String?
Target repository (e.g. 'owner/repo').
no setter
runNumber → String?
CI workflow run number string (e.g. '42').
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
workflow → String?
Workflow name string.
no setter

Methods

createContext() → CIContext
Construct a full CIContext snapshot of the current environment.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited