Skip to content

docs: [docs-drift] termination-metadata - #2768

Closed
timefold-automations[bot] wants to merge 1 commit into
mainfrom
docs-drift/termination-metadata
Closed

timefold-automations[bot] wants to merge 1 commit into
mainfrom
docs-drift/termination-metadata

Conversation

@timefold-automations

Copy link
Copy Markdown
Contributor

Merged group: #2758 by triceo; TimefoldAI/timefold-solver-enterprise#943 by triceo.

  1. Code change: TimefoldAI/timefold-solver, core/src/main/java/ai/timefold/solver/core/api/solver/phase/PhaseType.java:12-44, added the public PhaseType enum as part of the termination metadata API.
    Docs location: No mention found before this fix. docs/src/modules/ROOT/pages/running-timefold-solver/solver-diagnostics.adoc:528-529 now names PhaseType and explains the values returned by PhaseId.type().
    Confidence: high.
    What changed: Documented the new public enum in the run-summary diagnostics section.

  2. Code change: TimefoldAI/timefold-solver, core/src/main/java/ai/timefold/solver/core/api/solver/termination/TerminationType.java:15-68, added the public TerminationType enum.
    Docs location: No mention found before this fix. docs/src/modules/ROOT/pages/running-timefold-solver/solver-diagnostics.adoc:539-540 now names TerminationType and gives representative values.
    Confidence: high.
    What changed: Documented the new public enum alongside TerminationId.

  3. Code change: TimefoldAI/timefold-solver, core/src/main/java/ai/timefold/solver/core/api/solver/event/EventProducerId.java:58-113, deprecated all static event-producer factory methods for removal and introduced PhaseEventProducerId at core/src/main/java/ai/timefold/solver/core/api/solver/event/PhaseEventProducerId.java:11-16 as the phase-identification replacement.
    Docs location: No upgrade-guide entry existed. docs/src/modules/ROOT/pages/upgrading-timefold-solver/upgrade-to-latest.adoc:137-146 now lists the deprecated methods and directs users to PhaseEventProducerId.phaseId().
    Confidence: high.
    What changed: Added the required upgrade note for the deprecation and replacement API.

The group is already merged, so this pull request fixes main. It will be updated if more pull requests on the termination-metadata branch merge.

Generated by Solver Docs Drift Detector · copilot · gpt56 · 21.9 AIC · ⌖ 3.38 AIC · ⊞ 27.1K · ◷

@triceo

triceo commented Oct 21, 2026

Copy link
Copy Markdown
Collaborator

We need not document such trivial details.

@triceo triceo closed this Oct 21, 2026
@triceo
triceo deleted the docs-drift/termination-metadata branch October 21, 2026 06:38

This branch was successfully deployed

2 active deployments
documentation (preview) — 609da597 Deployed Oct 21, 2026 by timefold-automations[bot] via Build Documentation #824
internal — 609da597 Deployed Oct 21, 2026 by timefold-automations[bot] via approval_required #824
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component/docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant