Record Class PrepOutcome

java.lang.Object
java.lang.Record
network.ike.plugin.release.prep.PrepOutcome
Record Components:
projectId - the Maven artifact id read from rootPom
hasOrigin - whether origin is configured on the working tree
releaseTimestamp - the ISO-8601 UTC timestamp derived from the current HEAD commit; stamped into project.build.outputTimestamp for reproducibility
draftMode - true when the request is a draft preview — runGoal() short-circuits to the draft renderer instead of running the local/nexus/central/finalize phases
foundationUpgrades - the upstream-version pin bumps the B8 alignment step applied (empty when not a cascade member, every pin already current, or in draft mode) — surfaced in the release notes (#706)
public record PrepOutcome(String projectId, boolean hasOrigin, String releaseTimestamp, boolean draftMode, List<CascadeBump> foundationUpgrades) extends Record
Outcome of the ReleasePrep phase — values computed during B1–B12 that downstream phases consume.

draftMode drives the orchestrator dispatch: when true, runGoal() short-circuits to the draft renderer and returns instead of continuing into LocalPhase. The other fields (projectId, hasOrigin, releaseTimestamp) feed downstream phases that need them (LocalPhase reads releaseTimestamp; FinalizePhase reads projectId and hasOrigin; logAudit reads projectId).

foundationUpgrades carries the upstream-pin bumps the B8 alignment step applied, so FinalizePhase can surface them in the GitHub Release body — a cascade-only rebuild otherwise announces "no changes" (IKE-Network/ike-issues#706).

Carved out of ReleaseDraftMojo during the Phase 4 Commit 5 (IKE-Network/ike-issues#489).

  • Constructor Details

    • PrepOutcome

      public PrepOutcome(String projectId, boolean hasOrigin, String releaseTimestamp, boolean draftMode, List<CascadeBump> foundationUpgrades)
      Creates an instance of a PrepOutcome record class.
      Parameters:
      projectId - the value for the projectId record component
      hasOrigin - the value for the hasOrigin record component
      releaseTimestamp - the value for the releaseTimestamp record component
      draftMode - the value for the draftMode record component
      foundationUpgrades - the value for the foundationUpgrades record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • projectId

      public String projectId()
      Returns the value of the projectId record component.
      Returns:
      the value of the projectId record component

    • hasOrigin

      public boolean hasOrigin()
      Returns the value of the hasOrigin record component.
      Returns:
      the value of the hasOrigin record component

    • releaseTimestamp

      public String releaseTimestamp()
      Returns the value of the releaseTimestamp record component.
      Returns:
      the value of the releaseTimestamp record component

    • draftMode

      public boolean draftMode()
      Returns the value of the draftMode record component.
      Returns:
      the value of the draftMode record component

    • foundationUpgrades

      public List<CascadeBump> foundationUpgrades()
      Returns the value of the foundationUpgrades record component.
      Returns:
      the value of the foundationUpgrades record component