splunk-soar-sdk 1.0.0b3__tar.gz

splunk_soar_sdk-1.0.0b3/.github/utils/github.js

@@ -0,0 +1,89 @@
+import { readdir, readFile } from "node:fs/promises";
+
+async function getReleaseVersion() {
+  try {
+    return (await readFile("release_version.txt")).toString().trim();
+  } catch (err) {
+    if (err.code === "ENOENT") {
+      // File does not exist
+      return null;
+    }
+    throw err;
+  }
+}
+
+async function uploadReleaseArtifacts({ github, context }) {
+  const tag = await getReleaseVersion();
+  if (!tag) {
+    console.log("This change did not result in a release.");
+    return
+  }
+
+  const { owner, repo } = context.repo;
+
+  const files = await readdir("dist");
+  const artifacts = files.filter((f) => f.endsWith(".whl") || f.endsWith(".tar.gz"));
+
+  const getRelease = await github.rest.repos.getReleaseByTag({
+    owner,
+    repo,
+    tag,
+  });
+  const release_id = getRelease.data.id;
+
+  for await (const name of artifacts) {
+    const data = await readFile(`dist/${name}`);
+    await github.rest.repos.uploadReleaseAsset({
+      owner,
+      repo,
+      release_id,
+      name,
+      data,
+    });
+  }
+}
+
+async function commentReleaseNotes({ github, context }) {
+  let commentBody = "Merging this PR will not result in a release.";
+
+  const versionNumber = await getReleaseVersion();
+  if (versionNumber) {
+    const releaseNotes = (await readFile("release_notes.txt")).toString().trim();
+    commentBody = `Merging this PR will release \`${versionNumber}\` with the following release notes:\n\n${releaseNotes}`;
+  }
+
+  // Add an invisible breadcrumb to the comment body so we can find it later
+  const bodyBreadcrumb = "<!-- semantic-release-breadcrumb -->\n";
+  const issueContext = {
+    issue_number: context.issue.number,
+    owner: context.repo.owner,
+    repo: context.repo.repo,
+  };
+
+  const comment = {
+    ...issueContext,
+    body: `${bodyBreadcrumb}${commentBody}`,
+  };
+
+  for await (const { data } of github.paginate.iterator(
+    github.rest.issues.listComments, issueContext
+  )) {
+    for (const {id, body} of data) {
+      if (body.startsWith(bodyBreadcrumb)) {
+        console.log(`Updating comment ${id}`);
+        await github.rest.issues.updateComment({
+          comment_id: id,
+          ...comment,
+        });
+        return;
+      }
+    }
+  }
+
+  // Pre-condition: we haven't already commented on this PR
+  console.log("Creating comment");
+  await github.rest.issues.createComment(comment);
+  return;
+}
+
+export { uploadReleaseArtifacts, commentReleaseNotes };

splunk_soar_sdk-1.0.0b3/.github/utils/update_version.py

@@ -0,0 +1,47 @@
+import argparse
+
+from tomlkit import parse, dumps
+from tomlkit.container import Container
+
+from typing import cast
+
+
+def update_version(version: str) -> None:
+    pyproject_path = "pyproject.toml"
+
+    try:
+        # Read the pyproject.toml file
+        with open(pyproject_path) as file:
+            pyproject_content = file.read()
+
+        # Parse the TOML content
+        pyproject_data = parse(pyproject_content)
+
+        # Update the version in the "project" table
+        project_table = cast(Container, pyproject_data["project"])
+        project_table["version"] = version
+
+        # Write the updated content back to the file
+        with open(pyproject_path, "w") as file:
+            file.write(dumps(pyproject_data))
+
+        print(f"Version updated to {version} in pyproject.toml")
+
+    except FileNotFoundError:
+        print(f"Error: {pyproject_path} not found")
+    except Exception as e:
+        print(f"An error occurred: {e}")
+
+
+def parse_args() -> argparse.Namespace:
+    """Parse command line arguments."""
+    parser = argparse.ArgumentParser(description="Update the version in pyproject.toml")
+    parser.add_argument(
+        "version", type=str, help="New version to set in pyproject.toml"
+    )
+    return parser.parse_args()
+
+
+if __name__ == "__main__":
+    args = parse_args()
+    update_version(args.version)

splunk_soar_sdk-1.0.0b3/.github/workflows/code_quality.yml

@@ -0,0 +1,62 @@
+name: PR Checks
+on:
+  push:
+    branches:
+      - main
+      - beta
+  pull_request:
+    branches:
+      - main
+      - beta
+
+jobs:
+  Precommit:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: 3.13
+      - name: Install pre-commit
+        run: uv tool install pre-commit --with pre-commit-uv
+      - name: Run pre-commit
+        run: pre-commit run --all-files --show-diff-on-failure
+      - name: Cache pre-commit
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pre-commit
+          key: ${{ runner.os }}-pre-commit-cache
+
+  MyPy:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.9, 3.13]
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          python-version: ${{ matrix.python-version }}
+      - name: MyPy - ${{ matrix.python-version }}
+        run: uv run --locked mypy .
+
+  Pytest:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.9, 3.13]
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          python-version: ${{ matrix.python-version }}
+      - name: Pytest + Coverage - ${{ matrix.python-version }}
+        run: uv run --locked pytest

splunk_soar_sdk-1.0.0b3/.github/workflows/commit_hygiene.yml

@@ -0,0 +1,53 @@
+name: Commit Hygiene
+on:
+  pull_request:
+    branches:
+      - main
+      - beta
+
+jobs:
+  commitlint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Set up NodeJS
+        uses: actions/setup-node@v4
+        with:
+          node-version: "lts/*"
+      - name: Install commitlint
+        run: npm i -g @commitlint/cli @commitlint/config-conventional
+      - name: Commitlint
+        run: commitlint --from "origin/${{ github.base_ref }}" --to "origin/${{ github.head_ref }}"
+
+  semantic_release_dryrun:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Set up NodeJS
+        uses: actions/setup-node@v4
+        with:
+          node-version: "lts/*"
+      - name: Install semantic-release dependencies
+        run: npm install --global semantic-release @semantic-release/exec @semantic-release/git
+      - name: Check out the target branch and merge onto it
+        run: |
+          git fetch origin ${{ github.base_ref }}:${{ github.base_ref }}
+          git fetch origin ${{ github.head_ref }}:${{ github.head_ref }}
+          git checkout ${{ github.base_ref }}
+          git merge --ff-only ${{ github.head_ref }}
+      - name: Run Semantic Release as a dry run
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          unset GITHUB_ACTIONS GITHUB_REF GITHUB_EVENT_NAME
+          semantic-release --dry-run --no-ci
+      - name: Comment release notes on the PR
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const { commentReleaseNotes } = await import('${{ github.workspace }}/.github/utils/github.js');
+            await commentReleaseNotes({github, context, core});

splunk_soar_sdk-1.0.0b3/.github/workflows/semantic_release.yml

@@ -0,0 +1,54 @@
+name: Run Semantic Release
+on:
+  push:
+    branches:
+      - main
+      - beta
+
+jobs:
+  semantic_release:
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+    permissions:
+      contents: write  # Required for semantic-release to create release tags
+      pull-requests: write  # Required for semantic-release to comment on PRs in release
+      id-token: write  # Required for trusted publishing
+    steps:
+      - uses: actions/create-github-app-token@v1
+        id: app-token
+        with:
+          app-id: ${{ vars.SEMANTIC_RELEASE_APP_ID }}
+          private-key: ${{ secrets.SEMANTIC_RELEASE_PRIVATE_KEY }}
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          token: ${{ steps.app-token.outputs.token }}
+      - name: Set up NodeJS
+        uses: actions/setup-node@v4
+        with:
+          node-version: "lts/*"
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: 3.13
+      - name: Install semantic-release dependencies
+        run: npm install --global semantic-release @semantic-release/exec @semantic-release/git
+      - name: Run Semantic Release
+        env:
+          GITHUB_TOKEN: ${{ steps.app-token.outputs.token }}
+        run: semantic-release
+      - name: Check out the newly-created tag
+        run: git fetch --tags && git checkout "$(cat release_version.txt)"
+      - name: Build package
+        run: uv build
+      - name: Publish to PyPI
+        run: uv publish
+      - name: Find the GitHub release and upload the artifacts to it
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const { uploadReleaseArtifacts } = await import('${{ github.workspace }}/.github/utils/github.js');
+            uploadReleaseArtifacts({github, context, core});
+          github-token: ${{ steps.app-token.outputs.token }}

splunk_soar_sdk-1.0.0b3/.gitignore

@@ -0,0 +1,109 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+.DS_Store
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+juniy.xml
+
+# Translations
+*.mo
+*.po
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+.python-version
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+.idea/
+.vscode
+
+# built connector packages
+*.tgz
+*.tar.gz

splunk_soar_sdk-1.0.0b3/.pre-commit-config.yaml

@@ -0,0 +1,45 @@
+# By default, run each hook only in the standard pre-commit stage
+default_install_hook_types: [pre-commit, commit-msg]
+default_stages: [pre-commit]
+
+# Pre-commit hooks.   Configuration examples at https://pre-commit.com/
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-merge-conflict
+      - id: check-yaml
+        args:
+          - --unsafe
+      - id: check-json
+      - id: check-toml
+
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: 'v0.11.6'
+    hooks:
+      - id: ruff
+      - id: ruff-format
+
+  - repo: local
+    hooks:
+      - id: uv-lock
+        name: uv-lock
+        language: system
+        entry: uv lock
+        files: ^pyproject\.toml$
+        pass_filenames: false
+      - id: mypy
+        name: mypy
+        language: system
+        entry: uv run mypy .
+        types: [python]
+        pass_filenames: false
+
+  - repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
+    rev: v9.22.0
+    hooks:
+      - id: commitlint
+        stages: [commit-msg]
+        additional_dependencies: ['@commitlint/config-conventional']

splunk_soar_sdk-1.0.0b3/.releaserc

@@ -0,0 +1,37 @@
+{
+  "branches": [
+    "main",
+    {
+      "name": "alpha",
+      "prerelease": true
+    },
+    {
+      "name": "beta",
+      "prerelease": true
+    }
+  ],
+  "tagFormat": "${version}",
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    [
+      "@semantic-release/exec",
+      {
+        "prepareCmd": "uv run .github/utils/update_version.py ${nextRelease.version} && uv lock",
+        "verifyReleaseCmd": "echo \"${nextRelease.version}\" > release_version.txt",
+        "generateNotesCmd": "echo \"${nextRelease.notes}\" > release_notes.txt"
+      }
+    ],
+    [
+      "@semantic-release/git",
+      {
+        "assets": [
+          "pyproject.toml",
+          "uv.lock"
+        ],
+        "message": "chore(release): update version to ${nextRelease.version} [skip ci]"
+      }
+    ],
+    "@semantic-release/github"
+  ]
+}