Merge pull request #113 from Chisanan232/develop

[CU-86evcmf04] Improve the document and CI workflow of CI scripts

Author: Chisanan232

.github/workflows/rw_uv_run_test.yaml

@@ -75,6 +75,11 @@ on:
         type: string
         required: false
         default: '["ubuntu-latest", "ubuntu-22.04", "macos-latest", "macos-14"]'
+      handle-coverage-report:
+        description: "Enable to rename and upload pytest coverage reports."
+        type: boolean
+        required: false
+        default: true
     secrets:
       e2e_test_api_token:
         description: "Set the API token for end-to-end test if it needs."
@@ -106,6 +111,7 @@ jobs:
 
       - name: Install all the project dependencies
         if: ${{ inputs.install_dependency_with_group == '' }}
+        working-directory: ${{ inputs.test_working_directory }}
         run: uv sync --locked --all-extras --dev
 
       - name: Build Python runtime environment by UV with dependency group *${{ inputs.install_dependency_with_group }}*
@@ -147,11 +153,13 @@ jobs:
           E2E_TEST_API_TOKEN: ${{ secrets.e2e_test_api_token }}
 
       - name: Rename the code coverage result file
+        if: ${{ inputs.handle-coverage-report }}
         working-directory: ${{ inputs.test_working_directory }}
         run: |
           mv ./.coverage ./.coverage.${{ inputs.test_type }}.${{ matrix.os }}-${{ matrix.python-version }}
 
       - name: Upload code coverage result file
+        if: ${{ inputs.handle-coverage-report }}
         uses: actions/upload-artifact@v5
         with:
           name: coverage_${{ inputs.test_type }}_${{ matrix.os }}_${{ matrix.python-version }}

.github/workflows/test-ci-scripts.yaml

@@ -0,0 +1,48 @@
+name: CI
+
+on:
+  # No matter for push or pull request events, it would trigger CI for safely saving the source code.
+  # For the push event, it only runs building and testing.
+  push:
+    branches:
+      - "master"
+    paths:
+#     For GitHub Action
+      - ".github/workflows/test-ci-scripts.yaml"
+#     For source code and test
+      - "scripts/ci/**/*.py"
+      - "scripts/test/**/*.py"
+#     For configurations for test or CI
+      - "scripts/pytest.ini"
+#     For Python project configuration
+      - "scripts/pyproject.toml"
+      - "scripts/uv.lock"
+
+  # For the push event, in addition to build and test would be run, it would trigger other service to keep the reports
+  # or other checking, i.e., record the test report by CodeCov and check the code quality by SonarQube.
+  pull_request:
+    branches:
+      - "master"
+    paths:
+#     For GitHub Action
+      - ".github/workflows/test-ci-scripts.yaml"
+#     For source code and test
+      - "scripts/ci/**/*.py"
+      - "scripts/test/**/*.py"
+#     For configurations for test or CI
+      - "scripts/pytest.ini"
+#     For Python project configuration
+      - "scripts/pyproject.toml"
+      - "scripts/uv.lock"
+
+jobs:
+  run_script-test:
+#    name: Run all contract test items
+    uses: ./.github/workflows/rw_uv_run_test.yaml
+    with:
+      test_type: ci-script-test
+      test_folder: './test/ci_script_test'
+      python-versions: '["3.13"]'
+      operating-systems: '["ubuntu-latest", "ubuntu-22.04", "macos-latest", "macos-14"]'
+      test_working_directory: './scripts'
+      handle-coverage-report: false

docs/src/pages/showcase.tsx

@@ -14,10 +14,10 @@ const PROJECTS: ShowcaseProject[] = [
     isTemplate: true,
   },
   {
-    title: 'Slack-MCP-Server-Backend-MQ-Template',
-    description: 'A specialized template for building Slack MCP servers with message queue backends, featuring production-ready CI/CD workflows.',
-    website: 'https://github.com/Chisanan232/Slack-MCP-Server-Backend-MQ-Template',
-    source: 'https://github.com/Chisanan232/Slack-MCP-Server-Backend-MQ-Template',
+    title: 'Abstract Backend Implementation Template',
+    description: 'An opinionated starter kit that implements the Abstract Backend Execution pattern end-to-end with queue orchestration, observability, and CI/CD already wired in.',
+    website: 'https://github.com/Chisanan232/abstract-backend-implementation-template',
+    source: 'https://github.com/Chisanan232/abstract-backend-implementation-template',
     tags: ['template', 'mcp', 'message-queue', 'poetry'],
     isTemplate: true,
   },
@@ -43,10 +43,10 @@ const PROJECTS: ShowcaseProject[] = [
     tags: ['library', 'framework', 'backend', 'python'],
   },
   {
-    title: 'MCP-BackEnd-Message-Queue-Redis',
-    description: 'Redis-based message queue backend for MCP servers, showcasing integration testing with external services.',
-    website: 'https://github.com/Chisanan232/MCP-BackEnd-Message-Queue-Redis',
-    source: 'https://github.com/Chisanan232/MCP-BackEnd-Message-Queue-Redis',
+    title: 'ABE Redis',
+    description: 'Redis-backed queue implementation for the Abstract Backend Execution ecosystem, featuring async job processing, telemetry hooks, and integration test fixtures.',
+    website: 'https://github.com/Chisanan232/abe-redis',
+    source: 'https://github.com/Chisanan232/abe-redis',
     tags: ['library', 'redis', 'message-queue', 'integration'],
   },
 ];

scripts/ci/release_intent.py

@@ -29,9 +29,25 @@ class ReleaseIntentError(Exception):
     """Custom exception for release intent parsing errors."""
 
 
+def _resolve_tag_and_release_path() -> Path:
+    """Return the directory containing tag and release artifacts."""
+    candidates = [
+        Path.cwd() / ".github" / "tag_and_release",
+        Path.cwd().parent / ".github" / "tag_and_release",
+        Path(__file__).resolve().parent.parent / ".github" / "tag_and_release",
+    ]
+
+    for candidate in candidates:
+        if candidate.exists():
+            return candidate
+
+    # Fall back to current working directory even if it doesn't exist yet to provide consistent error messaging
+    return candidates[0]
+
+
 def load_schema() -> SchemaType:
     """Load and return the JSON schema for release intent validation."""
-    schema_path = Path("../.github/tag_and_release/schema.json")
+    schema_path = _resolve_tag_and_release_path() / "schema.json"
 
     if not schema_path.exists():
         raise ReleaseIntentError(f"Schema file not found: {schema_path}")
@@ -45,7 +61,7 @@ def load_schema() -> SchemaType:
 
 def load_intent_file() -> Optional[ReleaseIntent]:
     """Load the release intent YAML file if it exists."""
-    intent_path = Path("../.github/tag_and_release/intent.yaml")
+    intent_path = _resolve_tag_and_release_path() / "intent.yaml"
 
     if not intent_path.exists():
         return None

scripts/pyproject.toml

@@ -16,6 +16,11 @@ dependencies = [
 [project.scripts]
 release-intent = "ci.release_intent:main"
 
+[dependency-groups]
+dev = [
+    "pytest>=8.4.1,<9",
+]
+
 [tool.hatch.build.targets.sdist]
 include = ["ci/"]
 

scripts/pytest.ini

@@ -0,0 +1,21 @@
+# pytest.ini
+[pytest]
+minversion = 7.0.0
+addopts =
+;    --cov=slack_mcp/
+;    --cov-config=./.coveragerc
+;    --cov-report=term-missing
+;    --cov-fail-under=95
+    -r a
+    -vv
+;    --reruns 1
+
+log_cli = 1
+log_cli_level = INFO
+log_cli_format = %(asctime)s [%(levelname)8s] %(message)s (%(filename)s:%(lineno)s)
+log_cli_date_format=%Y-%m-%d %H:%M:%S
+
+# Filter warnings
+filterwarnings =
+    # Ignore coverage warning about --include being ignored
+    ignore:--include is ignored because --source is set