Skip to content

docs(release-notes): Document Context null-safety change in 2.2 - #234

Merged
kthoms merged 1 commit into
mainfrom
release-notes/2.2-context-config
Nov 5, 2026
Merged

kthoms merged 1 commit into
mainfrom
release-notes/2.2-context-config

Conversation

@kthoms

@kthoms kthoms commented Nov 5, 2026

Copy link
Copy Markdown
Contributor

Summary

Documents an internal API change in the 2.2 release notes that was missing, as promised in operaton/operaton#4038 (comment).

Since 2.2 (operaton/operaton#3550), Context.getProcessEngineConfiguration() and Context.getCommandContext() throw an IllegalStateException instead of returning null when no engine command is active on the current thread.

Changes in release-notes/2_2/index.md:

  • New section under Removed & Changed APIs describing the change, the exception messages, and the new findProcessEngineConfiguration() / hasActiveProcessEngineConfiguration() / findCommandContext() / hasActiveCommandContext() methods, with a migration example
  • Recommendation to use public service APIs (RuntimeService, DelegateExecution, ...) instead of internal Context
  • Warning box on internal .impl. packages
  • Nullability Declarations section no longer calls the effort "non-breaking" and links to the new section

Open point

The warning box states plans for 2.3 (explicit declaration of internal packages, stricter enforcement). Please confirm or drop before merging.

Test plan

  • npm run build succeeds; no broken links/anchors reported for release notes pages
  • #context-null-safety anchor renders

🤖 Generated with Claude Code

Context.getProcessEngineConfiguration() and Context.getCommandContext()
throw IllegalStateException in 2.2 instead of returning null when no
command is active. Document the change, the new find*/hasActive*
alternatives, and recommend public service APIs instead.

Related to operaton/operaton#4038

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Copilot AI balanced review requested due to automatic review settings November 5, 2026 10:07

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Needs a closer look

A maintainer must confirm or remove the unverified Operaton 2.3 commitment to internal-package declarations and stricter enforcement before publication.

No open issues 🎉

What changed in this PR

Documents the internal Context null-safety change in Operaton 2.2 and provides migration guidance for applications that previously relied on nullable getters.

Changes:

  • Describes the new exceptions, optional-returning alternatives, and context-presence checks.
  • Adds migration examples, recommends public APIs, and warns about internal API stability.
  • Updates the nullability section to acknowledge the behavior change and link to the new guidance.
File Description
docs/​documentation/​reference/​release-notes/​2_2/​index.md Adds Context migration guidance and internal API warnings; corrects the nullability overview.

Review effort: Balanced

@kthoms
kthoms merged commit e0d678b into main Nov 5, 2026
4 checks passed
@kthoms
kthoms deleted the release-notes/2.2-context-config branch November 5, 2026 14:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants