Merge branch 'main' into feat/withRetry

Author: wangyb-A

.github/DISCUSSION_TEMPLATE/major-releases.yml

@@ -0,0 +1,104 @@
+title: "[Major Release]: "
+labels: ["major-release", "breaking-change"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Use this template to propose a major version release. Major releases include breaking changes
+        that require careful planning, communication, and migration support.
+
+  - type: input
+    id: proposed-version
+    attributes:
+      label: Proposed Version Number
+      description: The target major version number for this release
+      placeholder: "e.g., 2.0.0"
+    validations:
+      required: true
+
+  - type: textarea
+    id: breaking-changes
+    attributes:
+      label: Description of the Breaking Changes
+      description: List all breaking changes included in this release with clear before/after examples
+      placeholder: |
+        1. **Change**: Description of the breaking change
+           - Before: `old_api()`
+           - After: `new_api()`
+
+        2. **Change**: Description of the breaking change
+           - Before: ...
+           - After: ...
+    validations:
+      required: true
+
+  - type: textarea
+    id: justification
+    attributes:
+      label: Justification for the Changes
+      description: Explain why these breaking changes are necessary and what problems they solve
+      placeholder: |
+        - Why can't this be done in a backward-compatible way?
+        - What user pain points or technical debt does this address?
+        - What benefits do users gain from upgrading?
+    validations:
+      required: true
+
+  - type: textarea
+    id: consuming-code-changes
+    attributes:
+      label: Changes Needed in Consuming Code
+      description: Describe what consumers of this SDK need to change in their code to adopt the new version
+      placeholder: |
+        - Step-by-step migration instructions
+        - Code examples showing required changes
+        - Any tooling or codemods available to assist migration
+    validations:
+      required: true
+
+  - type: textarea
+    id: inflight-impact
+    attributes:
+      label: Impact to In-flight Executions
+      description: Describe how this release affects durable executions that are currently in progress
+      placeholder: |
+        - Can in-flight executions continue running after upgrade?
+        - Is there a required draining period?
+        - Are checkpointed states compatible across versions?
+        - What happens to executions that are suspended (waiting)?
+    validations:
+      required: true
+
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives Explored
+      description: Describe alternative approaches that were considered and why they were not chosen
+      placeholder: |
+        1. **Alternative**: Description
+           - Pros: ...
+           - Cons: ...
+           - Why rejected: ...
+    validations:
+      required: true
+
+  - type: textarea
+    id: deprecation-changes
+    attributes:
+      label: Deprecation Changes Required for Previous Versions
+      description: Describe deprecation notices, warnings, or shims that should be added to the current major version before this release
+      placeholder: |
+        - What deprecation warnings should be added to the current release?
+        - What is the proposed deprecation timeline?
+        - Are there compatibility shims or adapters to ease migration?
+    validations:
+      required: true
+
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional Context
+      description: Any other context, timeline considerations, or references
+      placeholder: Additional information...
+    validations:
+      required: false

.github/hooks/pre-commit

@@ -0,0 +1,9 @@
+#!/bin/sh
+
+if hatch fmt --check; then
+    echo "Hatch fmt check passed!"
+else
+    hatch fmt
+    echo "Error: hatch fmt modified your files. Please re-stage and commit again."
+    exit 1
+fi

.github/scripts/lintcommit.py

@@ -164,7 +164,8 @@ def lint_range(git_range: str, *, skip_dirty_check: bool = False) -> LintResult:
         status = subprocess.run(
             ["git", "status", "--porcelain"],
             capture_output=True,
-            text=True, check=False,
+            text=True,
+            check=False,
         )
         if status.stdout.strip():
             return LintResult(
@@ -178,7 +179,8 @@ def lint_range(git_range: str, *, skip_dirty_check: bool = False) -> LintResult:
     result = subprocess.run(
         ["git", "log", "--no-merges", git_range, "-z", "--format=%H%n%B"],
         capture_output=True,
-        text=True, check=False,
+        text=True,
+        check=False,
     )
     if result.returncode != 0:
         return LintResult(git_error=result.stderr.strip())

.github/workflows/ci.yml

@@ -7,6 +7,7 @@ permissions:
 
 on:
   push:
+    branches: [ main ]
 
   pull_request:
     branches: [ main ]

.github/workflows/deploy-examples.yml

@@ -58,14 +58,12 @@ jobs:
     - name: Install Hatch
       run: pip install hatch
     - name: Build examples
-      working-directory: ./packages/aws-durable-execution-sdk-python-examples
       run: |
-        hatch run -- examples:pip install -e ../aws-durable-execution-sdk-python
+        hatch run -- examples:pip install -e packages/aws-durable-execution-sdk-python packages/aws-durable-execution-sdk-python-otel
         hatch run examples:build
 
     - name: Deploy Lambda function - ${{ matrix.example.name }}
       id: deploy
-      working-directory: ./packages/aws-durable-execution-sdk-python-examples
       env:
         AWS_ACCOUNT_ID: ${{ secrets.AWS_ACCOUNT_ID }}
         LAMBDA_ENDPOINT: "https://lambda.us-west-2.amazonaws.com"

.github/workflows/integration-tests.yml

@@ -97,15 +97,15 @@ jobs:
         rm -rf /tmp/aws/
 
     - name: Deploy and test examples
-      working-directory: language-sdk/packages/aws-durable-execution-sdk-python-examples
+      working-directory: language-sdk
       env:
         AWS_ACCOUNT_ID: ${{ secrets.AWS_ACCOUNT_ID }}
         LAMBDA_ENDPOINT: "https://lambda.us-west-2.amazonaws.com"
         INVOKE_ACCOUNT_ID: ${{ secrets.INVOKE_ACCOUNT_ID }}
         KMS_KEY_ARN: ${{ secrets.KMS_KEY_ARN }}
       run: |
         echo "Building examples..."
-        hatch run -- examples:pip install -e ../testing-sdk
+        hatch run -- examples:pip install -e packages/testing-sdk
         hatch run examples:build
 
         # Get first integration example for testing

.github/workflows/scorecard.yml

@@ -75,6 +75,6 @@ jobs:
       # Upload the results to GitHub's code scanning dashboard (optional).
       # Commenting out will disable upload of results to your repo's Code Scanning dashboard
       - name: "Upload to code-scanning"
-        uses: github/codeql-action/upload-sarif@7211b7c8077ea37d8641b6271f6a365a22a5fbfa # v4.36.0
+        uses: github/codeql-action/upload-sarif@8aad20d150bbac5944a9f9d289da16a4b0d87c1e # v4.36.2
         with:
           sarif_file: results.sarif

CONTRIBUTING.md

@@ -92,8 +92,7 @@ hatch fmt
 # Build distribution
 hatch build
 
-# Examples deployment (from examples package)
-cd ../aws-durable-execution-sdk-python-examples
+# Examples deployment (from repo root)
 hatch run examples:build
 hatch run examples:deploy "Hello World"
 ```
@@ -309,7 +308,7 @@ tests/mypackage/mymodule_test.py
 ## Examples and Deployment
 
 The project includes a unified CLI tool for managing examples, deployment, and AWS account setup.
-Run these commands from the examples package directory (`packages/aws-durable-execution-sdk-python-examples`).
+Run these commands from the **repository root**.
 
 To run examples tests from the repo root:
 ```bash

packages/aws-durable-execution-sdk-python-examples/cli.py

@@ -5,6 +5,7 @@
 import logging
 import os
 import shutil
+import subprocess
 import sys
 import time
 import zipfile
@@ -35,6 +36,7 @@ def build_examples():
 
     build_dir = Path(__file__).parent / "build"
     src_dir = Path(__file__).parent / "src"
+    packages_dir = Path(__file__).parent.parent
 
     logger.info("Building examples...")
 
@@ -57,15 +59,29 @@ def build_examples():
         logger.exception("Failed to copy testing library")
         return False
 
-    # Copy SDK source from the main SDK package
-    testing_src = (
-        Path(__file__).parent.parent
-        / "aws-durable-execution-sdk-python"
-        / "src"
-        / "aws_durable_execution_sdk_python"
-    )
-    logger.info("Copying SDK from %s", testing_src)
-    shutil.copytree(testing_src, build_dir / "aws_durable_execution_sdk_python")
+    # Install local packages so their runtime dependencies are included in
+    # the Lambda deployment package.
+    runtime_packages = [
+        packages_dir / "aws-durable-execution-sdk-python",
+        packages_dir / "aws-durable-execution-sdk-python-otel",
+    ]
+    try:
+        subprocess.run(
+            [
+                sys.executable,
+                "-m",
+                "pip",
+                "install",
+                "--upgrade",
+                "--target",
+                str(build_dir),
+                *[str(package) for package in runtime_packages],
+            ],
+            check=True,
+        )
+    except subprocess.CalledProcessError:
+        logger.exception("Failed to install runtime dependencies")
+        return False
 
     # Copy example functions
     logger.info("Copying examples from %s", src_dir)

packages/aws-durable-execution-sdk-python-examples/examples-catalog.json

@@ -604,15 +604,37 @@
       "path": "./src/parallel/parallel_with_named_branches.py"
     },
     {
-      "name": "With Retry Callback",
-      "description": "Demonstrates with_retry wrapping a wait_for_callback operation with exponential backoff",
-      "handler": "with_retry_callback.handler",
+        "name": "With Retry Callback",
+        "description": "Demonstrates with_retry wrapping a wait_for_callback operation with exponential backoff",
+        "handler": "with_retry_callback.handler",
+        "integration": true,
+        "durableConfig": {
+          "RetentionPeriodInDays": 7,
+          "ExecutionTimeout": 300
+        },
+        "path": "./src/with_retry/with_retry_callback.py"
+    },
+    {
+      "name": "Plugin",
+      "description": "Test plugin",
+      "handler": "execution_with_plugin.handler",
+      "integration": true,
+      "durableConfig": {
+        "RetentionPeriodInDays": 7,
+        "ExecutionTimeout": 300
+      },
+      "path": "./src/plugin/execution_with_plugin.py"
+    },
+    {
+      "name": "Otel Plugin",
+      "description": "Test Otel plugin",
+      "handler": "execution_with_otel.handler",
       "integration": true,
       "durableConfig": {
         "RetentionPeriodInDays": 7,
         "ExecutionTimeout": 300
       },
-      "path": "./src/with_retry/with_retry_callback.py"
+      "path": "./src/plugin/execution_with_otel.py"
     }
   ]
 }