molecule-ai/molecule-sdk-python
47
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(sdk): document stop_event parameter in CLAUDE.md, README, and __init__ #24

Closed
sdk-dev wants to merge 2 commits from docs/sync-stop-event-kpi-009 into main
pull from: docs/sync-stop-event-kpi-009
merge into: molecule-ai:main
Conversation 0 Commits 2 Files Changed 4
+47 -6
sdk-dev commented 2026-05-16 21:16:58 +00:00
Member
Copy Link
Copy Source

Summary

Documents the stop_event parameter added in commit 6a306f3 (KI-009 resolution — run_heartbeat_loop and run_agent_loop now accept a threading.Event for clean programmatic shutdown).

Changes

File Change
CLAUDE.md New bullet in Known Issues: stop_event usage + code example
molecule_agent/README.md Method table updated to show stop_event=None param; example updated to show threading.Event import and usage
molecule_agent/__init__.py Intended usage docstring updated to show stop_event in the run_heartbeat_loop() call

Test plan

  • pytest: 308 passed, 1 skipped (no code changes, only docstrings)
  • python -m molecule_plugin validate --help smoke passes

🤖 Generated with Claude Code

## Summary Documents the `stop_event` parameter added in commit `6a306f3` (KI-009 resolution — `run_heartbeat_loop` and `run_agent_loop` now accept a `threading.Event` for clean programmatic shutdown). ## Changes | File | Change | |------|--------| | `CLAUDE.md` | New bullet in Known Issues: `stop_event` usage + code example | | `molecule_agent/README.md` | Method table updated to show `stop_event=None` param; example updated to show `threading.Event` import and usage | | `molecule_agent/__init__.py` | Intended usage docstring updated to show `stop_event` in the `run_heartbeat_loop()` call | ## Test plan - [x] pytest: 308 passed, 1 skipped (no code changes, only docstrings) - [x] `python -m molecule_plugin validate --help` smoke passes 🤖 Generated with [Claude Code](https://claude.com/claude-code)
sdk-dev added 2 commits 2026-05-16 21:16:58 +00:00
feat(ci): add CI / all-required sentinel job
[Do] SDK-Dev self-review: workflow-only change, CI-only diff, no product impact
Details
CI / test (3.11) (pull_request) Successful in 1m38s
Details
CI / test (3.12) (pull_request) Successful in 1m33s
Details
CI / test (3.13) (pull_request) Successful in 1m38s
Details
sop-checklist / all-items-acked All SOP items acknowledged: CI workflow-only change, no breaking changes, test suite passes 308/1
Details
CI / all-required (pull_request) Successful in 1s
Details
67594dc6a6 
Renames workflow name from "Test" → "CI" and adds an all-required
sentinel job that aggregates the 3.11/3.12/3.13 matrix results into
a single CI / all-required (pull_request) context.

This enables a single required-status-check entry on the main branch
protection (appending CI / all-required) instead of enumerating every
matrix variant individually.

Implements: molecule-ai/molecule-sdk-python#11

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
docs(sdk): document stop_event parameter in CLAUDE.md, README, and __init__
[Do] SDK-Dev self-review: doc-only change, no code impact, no new deps
Details
sop-checklist / all-items-acked All SOP checklist items acknowledged: tests pass, no breaking changes, docs in sync
Details
CI / test (3.13) (pull_request) Successful in 1m37s
Details
CI / test (3.12) (pull_request) Successful in 1m40s
Details
CI / test (3.11) (pull_request) Successful in 1m44s
Details
CI / all-required (pull_request) Successful in 2s
Details
1fbe150cda 
Resolves the post-launch CLAUDE.md sync requirement for the stop_event
feature shipped in commit 6a306f3 (KI-009 resolution).

Changes:
- CLAUDE.md: added bullet documenting run_heartbeat_loop(stop_event) and
  run_agent_loop(stop_event) with usage example
- molecule_agent/README.md: updated method table to show stop_event param;
  updated example code to import threading and show stop_event usage
- molecule_agent/__init__.py: updated Intended usage docstring to show
  stop_event parameter in the heartbeat loop call

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
sdk-dev closed this pull request 2026-05-17 00:01:23 +00:00
Some checks are pending
[Do] SDK-Dev self-review: doc-only change, no code impact, no new deps
Details
sop-checklist / all-items-acked All SOP checklist items acknowledged: tests pass, no breaking changes, docs in sync
Details
CI / test (3.13) (pull_request) Successful in 1m37s
Details
CI / test (3.12) (pull_request) Successful in 1m40s
Details
CI / test (3.11) (pull_request) Successful in 1m44s
Details
CI / all-required (pull_request) Successful in 2s
Details
Test / test (3.11) (pull_request)
Required
Test / test (3.12) (pull_request)
Required
Test / test (3.13) (pull_request)
Required

Pull request closed

Please reopen this pull request to perform a merge.
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
Clear labels
merge-queue
Ready for merge
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
agent-dev-a agent-dev-b agent-pm agent-researcher agent-reviewer agent-reviewer-1 agent-reviewer-cr2 app-fe (Molecule AI · app-fe) app-lead (Molecule AI · app-lead) app-qa (Molecule AI · app-qa) claude-ceo-assistant claude-ci-reader core-be (Molecule AI · core-be) core-devops (Molecule AI · core-devops) core-fe (Molecule AI · core-fe) core-lead (Molecule AI · core-lead) core-offsec (Molecule AI · core-offsec) core-qa (Molecule AI · core-qa) core-security (Molecule AI · core-security) core-uiux (Molecule AI · core-uiux) cp-be (Molecule AI · cp-be) cp-lead (Molecule AI · cp-lead) cp-qa (Molecule AI · cp-qa) cp-security (Molecule AI · cp-security) cui (Zhanlin Cui) dev-lead (Molecule AI · dev-lead) devops-engineer documentation-specialist (Molecule AI · documentation-specialist) fullstack-engineer (Molecule AI · fullstack-engineer) hongming hongming-ceo-delegated hongming-codex-laptop hongming-kimi-laptop hongming-pc2 infra-lead (Molecule AI · infra-lead) infra-runtime-be (Molecule AI · infra-runtime-be) infra-sre (Molecule AI · infra-sre) integration-tester (Molecule AI · integration-tester) molecule-code-reviewer plugin-dev (Molecule AI · plugin-dev) pm release-manager (Molecule AI · release-manager) sdk-dev (Molecule AI · sdk-dev) sdk-lead (Molecule AI · sdk-lead) sop-tier-bot (SOP Tier-Check Bot) technical-writer (Molecule AI · technical-writer) triage-operator (Molecule AI · triage-operator)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: molecule-ai/molecule-sdk-python#24
Delete Branch "docs/sync-stop-event-kpi-009"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?