Prepare for Beta release (#731)

https://packaging.python.org/en/latest/specifications/version-specifiers/#version-specifiers

Author: Ickerday

.basedpyright/baseline.json

@@ -0,0 +1,28 @@
+name: Run Splunk AppInspect
+description: Package a mock app containing the SDK and its dependencies, then validate it with AppInspect.
+
+inputs:
+  mock-app-path:
+    description: Path to app packaged for scanning with AppInspect
+    required: true
+    default: ./tests/system/test_apps/generating_app
+
+runs:
+  using: composite
+  steps:
+    - name: Install AppInspect dependencies
+      shell: bash
+      run: sudo apt-get install -y libmagic1
+    - name: Install the SDK and its dependencies into the mock app
+      shell: bash
+      run: |
+        mkdir -p ${{ inputs.mock-app-path }}/bin/lib
+        uv pip install ".[openai, anthropic]" --target ${{ inputs.mock-app-path }}/bin/lib
+    - name: Package the mock app
+      shell: bash
+      run: |
+        cd ${{ inputs.mock-app-path }}
+        tar -czf mock_app.tgz --exclude="__pycache__" bin default metadata
+    - name: Validate the mock app with AppInspect
+      shell: bash
+      run: uvx splunk-appinspect inspect ${{ inputs.mock-app-path }}/mock_app.tgz --included-tags cloud

.github/actions/run-appinspect/action.yml

@@ -5,18 +5,24 @@ inputs:
   python-version:
     description: Python version used for this run
     required: true
+    default: "3.13"
   deps-group:
     description: Dependency groups passed to `uv sync --group`
     required: true
+    default: dev
 
 runs:
   using: composite
   steps:
     - uses: astral-sh/setup-uv@cec208311dfd045dd5311c1add060b2062131d57
       with:
         version: 0.11.6
-        activate-environment: true
         python-version: ${{ inputs.python-version }}
-    - name: Install dependencies from the ${{ inputs.deps-group }} group(s)
-      run: SDK_DEPS_GROUP="${{ inputs.deps-group }}" make uv-sync-ci
+        activate-environment: true
+        enable-cache: true
+        cache-python: true
+    - name: Install dependencies from the ${{ inputs.deps-group }} group
+      env:
+        SDK_DEPS_GROUP: ${{ inputs.deps-group }}
       shell: bash
+      run: SDK_DEPS_GROUP="${{ inputs.deps-group }}" make ci-install

.github/actions/setup-sdk-environment/action.yml

@@ -1,9 +1,8 @@
 name: Validate SDK with Splunk AppInspect
-on: [ push, workflow_dispatch ]
+on: [push, workflow_dispatch]
 
 env:
   PYTHON_VERSION: 3.13
-  MOCK_APP_PATH: ./tests/system/test_apps/generating_app
 
 jobs:
   appinspect:
@@ -14,16 +13,5 @@ jobs:
         with:
           python-version: ${{ env.PYTHON_VERSION }}
           deps-group: lint
-      - name: Install splunk-appinspect dependencies
-        run: sudo apt-get install -y libmagic1
-      - name: Install packages for the mock app
-        run: |
-          mkdir -p ${{ env.MOCK_APP_PATH }}/bin/lib
-          uv pip install ".[openai, anthropic]" --target ${{ env.MOCK_APP_PATH }}/bin/lib
-      - name: Copy splunklib to a test app and package it as a mock app
-        run: |
-          cd ${{ env.MOCK_APP_PATH }}
-          tar -czf mock_app.tgz --exclude="__pycache__" bin default metadata
-      - name: Validate mock app with splunk-appinspect
-        run: uvx splunk-appinspect inspect ${{ env.MOCK_APP_PATH }}/mock_app.tgz
-          --included-tags cloud
+      - name: Run AppInspect
+        uses: ./.github/actions/run-appinspect

.github/workflows/appinspect.yml

@@ -2,7 +2,7 @@ name: Python SDK Lint
 on: [push, workflow_dispatch]
 
 jobs:
-  lint-stage:
+  lint:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
@@ -12,5 +12,5 @@ jobs:
           deps-group: lint
       - name: Verify uv.lock is up-to-date
         run: uv lock --check
-      - name: Verify against basedpyright baseline
-        run: uv run --frozen basedpyright
+      - name: Verify files are linted and formatted
+        run: make ci-lint

.github/workflows/lint.yml

@@ -1,14 +1,19 @@
-name: Publish SDK to Test PyPI
-on: [workflow_dispatch]
+name: Publish pre-release to Test PyPI
+on:
+  push:
+    branches:
+      - develop
+      - release/2.x
+  workflow_dispatch:
 
 env:
   PYTHON_VERSION: 3.13
 
 jobs:
-  publish-to-test-pypi:
+  publish-pre-release:
     runs-on: ubuntu-latest
     permissions:
-      id-token: write
+      id-token: write # Required for publishing
     environment:
       name: splunk-test-pypi
     steps:
@@ -17,8 +22,16 @@ jobs:
         with:
           python-version: ${{ env.PYTHON_VERSION }}
           deps-group: release
+      - name: Set temporary pre-release version
+        run: |
+          VERSION_BASE="$(uv version --short)"
+          RUN_NUMBER="${{ github.run_number }}"
+          COMMIT_SHA="$(git rev-parse --short HEAD)"
+          uv version --frozen "${VERSION_BASE}.dev${RUN_NUMBER}+g${COMMIT_SHA}"
       - name: Build packages for distribution
         run: uv build
+      - name: Run AppInspect
+        uses: ./.github/actions/run-appinspect
       - name: Publish packages to Test PyPI
         uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b
         with:

.github/workflows/pre-release.yml

@@ -10,7 +10,7 @@ jobs:
   publish-to-pypi:
     runs-on: ubuntu-latest
     permissions:
-      id-token: write
+      id-token: write # Required for publishing
     environment:
       name: splunk-pypi
     steps:
@@ -21,6 +21,8 @@ jobs:
           deps-group: release
       - name: Build packages for distribution
         run: uv build
+      - name: Run AppInspect
+        uses: ./.github/actions/run-appinspect
       - name: Publish packages to PyPI
         uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b
         with:

.github/workflows/release.yml

@@ -6,41 +6,41 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  test-stage:
-    runs-on: ${{ matrix.os }}
+  test:
     strategy:
       matrix:
         os: [ubuntu-latest]
         python-version: [3.13]
         splunk-version: [latest]
+    runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
       - uses: ./.github/actions/setup-sdk-environment
         with:
           python-version: ${{ matrix.python-version }}
           deps-group: test
       - name: Download Splunk MCP Server App
-        run: uv run ./scripts/download_splunk_mcp_server_app.py
         env:
           SPLUNKBASE_USERNAME: ${{ secrets.SPLUNKBASE_USERNAME }}
           SPLUNKBASE_PASSWORD: ${{ secrets.SPLUNKBASE_PASSWORD }}
+        run: uv run ./scripts/download_splunk_mcp_server_app.py
       - name: Launch Splunk Docker instance
         run: SPLUNK_VERSION=${{ matrix.splunk-version }} docker compose up -d
       - name: Set up .env
         run: cp .env.template .env
       - name: Write internal AI secrets to .env
-        run: |
-          echo "internal_ai_app_key=$INTERNAL_AI_APP_KEY" >> .env
-          echo "internal_ai_client_id=$INTERNAL_AI_CLIENT_ID" >> .env
-          echo "internal_ai_client_secret=$INTERNAL_AI_CLIENT_SECRET" >> .env
-          echo "internal_ai_token_url=$INTERNAL_AI_TOKEN_URL" >> .env
-          echo "internal_ai_base_url=$INTERNAL_AI_BASE_URL" >> .env
         env:
           INTERNAL_AI_APP_KEY: ${{ secrets.INTERNAL_AI_APP_KEY }}
           INTERNAL_AI_CLIENT_ID: ${{ secrets.INTERNAL_AI_CLIENT_ID }}
           INTERNAL_AI_CLIENT_SECRET: ${{ secrets.INTERNAL_AI_CLIENT_SECRET }}
           INTERNAL_AI_TOKEN_URL: ${{ secrets.INTERNAL_AI_TOKEN_URL }}
           INTERNAL_AI_BASE_URL: ${{ secrets.INTERNAL_AI_BASE_URL }}
+        run: |
+          echo "internal_ai_app_key=$INTERNAL_AI_APP_KEY" >> .env
+          echo "internal_ai_client_id=$INTERNAL_AI_CLIENT_ID" >> .env
+          echo "internal_ai_client_secret=$INTERNAL_AI_CLIENT_SECRET" >> .env
+          echo "internal_ai_token_url=$INTERNAL_AI_TOKEN_URL" >> .env
+          echo "internal_ai_base_url=$INTERNAL_AI_BASE_URL" >> .env
       - name: Restore pytest cache
         if: ${{ github.ref != 'refs/heads/master' && github.ref != 'refs/heads/develop' }}
         uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae
@@ -51,5 +51,5 @@ jobs:
             pytest-cache-${{ runner.os }}-py${{ matrix.python-version }}-${{ github.ref_name }}-
       - name: Run unit tests
         run: make test-unit
-      - name: Run entire test suite
+      - name: Run integration/system tests
         run: make test-integration

.github/workflows/test.yml

@@ -6,20 +6,39 @@
 # --no-config skips Splunk's internal PyPI mirror
 UV_SYNC_CMD := uv sync --no-config
 
-.PHONY: uv-sync
-uv-sync:
+.PHONY: install
+install:
 	$(UV_SYNC_CMD) --dev
 
-.PHONY: uv-upgrade
-uv-upgrade:
+.PHONY: upgrade
+upgrade:
 	$(UV_SYNC_CMD) --dev --upgrade
 
-
 # Workaround for make being unable to pass arguments to underlying cmd
 # $ SDK_DEPS_GROUP="build" make uv-sync-ci
-.PHONY: uv-sync-ci
-uv-sync-ci:
-	uv sync --locked --group $(SDK_DEPS_GROUP)
+.PHONY: ci-install
+ci-install:
+	$(UV_SYNC_CMD) --group $(SDK_DEPS_GROUP)
+
+UV_RUN_CMD := uv run --frozen --no-config
+.PHONY: lint
+lint: lint-python # TODO: Add mbake
+
+.PHONY: lint-python
+lint-python:
+	$(UV_RUN_CMD) basedpyright
+	$(UV_RUN_CMD) ruff check --fix-only
+	$(UV_RUN_CMD) ruff format
+
+UV_RUN_CMD := uv run --frozen --no-config
+.PHONY: ci-lint
+ci-lint: ci-lint-python # TODO: Add mbake
+
+.PHONY: ci-lint-python
+ci-lint-python:
+	$(UV_RUN_CMD) basedpyright
+# 	$(UV_RUN_CMD) ruff check
+# 	$(UV_RUN_CMD) ruff format --check
 
 .PHONY: clean
 clean:
@@ -97,4 +116,4 @@ docker-splunk-restart:
 
 .PHONY: docker-tail-python-log
 docker-tail-python-log:
-	docker exec -it $(CONTAINER_NAME) sudo tail $(SPLUNK_HOME)/var/log/splunk/python.log
+	docker exec -it $(CONTAINER_NAME) sudo tail $(SPLUNK_HOME)/var/log/splunk/python.log

Makefile

@@ -9,10 +9,9 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
+import importlib.metadata
 from datetime import datetime
 
-import splunklib
-
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
@@ -41,16 +40,15 @@
 
 # General information about the project.
 project = "Splunk SDK for Python"
-copyright = f"{datetime.now().year}, Splunk Inc."
+copyright = f"2011-{datetime.now().year} Splunk, Inc."
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = splunklib.__version__
-# The full version, including alpha/beta/rc tags.
-release = splunklib.__version__
+release = importlib.metadata.version("splunk-sdk")
+version = ".".join(release.split(".")[:2])
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.