fix: add support for alternate name for env var: SERPAPI_KEY

Author: adarshdigievo

.github/workflows/ci.yml

@@ -165,6 +165,7 @@ jobs:
       github.event_name == 'workflow_dispatch'
     env:
       SERPAPI_API_KEY: ${{ secrets.SERPAPI_API_KEY }}
+      SERPAPI_KEY: ${{ secrets.SERPAPI_KEY }}
       SERPAPI_WEEKLY: ${{ github.event_name == 'schedule' && '1' || '0' }}
       SERPAPI_LIVE_KEY_ARTIFACT: live-response-keys.json
     steps:
@@ -176,7 +177,7 @@ jobs:
 
       - run: uv sync --dev --locked
       - name: Require the live-test API key
-        run: test -n "$SERPAPI_API_KEY"
+        run: test -n "$SERPAPI_API_KEY" || test -n "$SERPAPI_KEY"
       - name: Run live search suite
         run: uv run tox -e live
       - name: Upload weekly response-key inventory
@@ -196,6 +197,7 @@ jobs:
       github.event_name == 'workflow_dispatch'
     env:
       SERPAPI_API_KEY: ${{ secrets.SERPAPI_API_KEY }}
+      SERPAPI_KEY: ${{ secrets.SERPAPI_KEY }}
     strategy:
       fail-fast: false
       matrix:
@@ -248,7 +250,7 @@ jobs:
 
       - run: uv sync --dev --locked
       - name: Require the live-test API key
-        run: test -n "$SERPAPI_API_KEY"
+        run: test -n "$SERPAPI_API_KEY" || test -n "$SERPAPI_KEY"
       - name: Run one real search through the native SDK tool
         run: >-
           uv run tox -e ${{ matrix.tox-environment }} --

.github/workflows/release.yml

@@ -54,6 +54,7 @@ jobs:
     runs-on: ubuntu-latest
     env:
       SERPAPI_API_KEY: ${{ secrets.SERPAPI_API_KEY }}
+      SERPAPI_KEY: ${{ secrets.SERPAPI_KEY }}
     steps:
       - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
       - uses: astral-sh/setup-uv@d4b2f3b6ecc6e67c4457f6d3e41ec42d3d0fcb86 # v5
@@ -71,7 +72,7 @@ jobs:
           uv pip install --python .release-venv/bin/python dist/*.whl
           .release-venv/bin/python tests/clean_install_smoke.py
       - name: Require the live-test API key
-        run: test -n "$SERPAPI_API_KEY"
+        run: test -n "$SERPAPI_API_KEY" || test -n "$SERPAPI_KEY"
       - name: Run live search suite with the exact release wheel
         run: |
           uv pip install --python .release-venv/bin/python "pytest>=8.4,<9"

.github/workflows/testpypi.yml

@@ -55,6 +55,7 @@ jobs:
     runs-on: ubuntu-latest
     env:
       SERPAPI_API_KEY: ${{ secrets.SERPAPI_API_KEY }}
+      SERPAPI_KEY: ${{ secrets.SERPAPI_KEY }}
     steps:
       - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
         with:
@@ -74,7 +75,7 @@ jobs:
           uv pip install --python .testpypi-venv/bin/python dist/*.whl
           .testpypi-venv/bin/python tests/clean_install_smoke.py
       - name: Require the live-test API key
-        run: test -n "$SERPAPI_API_KEY"
+        run: test -n "$SERPAPI_API_KEY" || test -n "$SERPAPI_KEY"
       - name: Run live search suite with the exact TestPyPI wheel
         run: |
           uv pip install --python .testpypi-venv/bin/python "pytest>=8.4,<9"

docs/user_guide/31-contributing.qmd

@@ -68,8 +68,9 @@ supported SDK adapters before publishing.
 
 Configure a protected GitHub environment named `testpypi`, restrict it to
 `main`, and create a TestPyPI Trusted Publisher for workflow `testpypi.yml` and
-environment `testpypi`. The live wheel gate also requires the repository's
-`SERPAPI_API_KEY` secret. No TestPyPI password or API token is stored in GitHub.
+environment `testpypi`. The live wheel gate also requires a repository secret
+named `SERPAPI_API_KEY` or `SERPAPI_KEY`. No TestPyPI password or API token is
+stored in GitHub.
 
 Run the workflow from the Actions page with `main` selected. Duplicate versions
 fail intentionally because TestPyPI does not allow a project version to be

tests/test_docs_site.py

@@ -287,6 +287,9 @@ def test_testpypi_workflow_is_manual_main_only_and_matches_release_gates() -> No
     assert "testpypi-distributions" in verify
     assert "tests/clean_install_smoke.py" in verify
     assert "tests/test_live.py" in verify
+    assert "SERPAPI_API_KEY: ${{ secrets.SERPAPI_API_KEY }}" in verify
+    assert "SERPAPI_KEY: ${{ secrets.SERPAPI_KEY }}" in verify
+    assert 'test -n "$SERPAPI_API_KEY" || test -n "$SERPAPI_KEY"' in verify
 
     frameworks = _workflow_job_text(workflow, "framework-tests")
     assert "needs: test" in frameworks
@@ -315,7 +318,10 @@ def test_ci_separates_quality_basic_framework_and_live_checks() -> None:
     live_adapters = _workflow_job_text(ci, "live-adapters")
 
     assert "SERPAPI_API_KEY" not in frameworks
+    assert "SERPAPI_KEY" not in frameworks
     assert "SERPAPI_API_KEY: ${{ secrets.SERPAPI_API_KEY }}" in live
+    assert "SERPAPI_KEY: ${{ secrets.SERPAPI_KEY }}" in live
+    assert 'test -n "$SERPAPI_API_KEY" || test -n "$SERPAPI_KEY"' in live
     assert "needs: quality" in live
     assert "github.event_name == 'push' && github.ref == 'refs/heads/main'" in live
     assert "github.event_name == 'schedule'" in live
@@ -325,6 +331,8 @@ def test_ci_separates_quality_basic_framework_and_live_checks() -> None:
 
     assert "needs: quality" in live_adapters
     assert "SERPAPI_API_KEY: ${{ secrets.SERPAPI_API_KEY }}" in live_adapters
+    assert "SERPAPI_KEY: ${{ secrets.SERPAPI_KEY }}" in live_adapters
+    assert 'test -n "$SERPAPI_API_KEY" || test -n "$SERPAPI_KEY"' in live_adapters
     assert "tests/test_live_adapters.py" in live_adapters
 
 
@@ -344,6 +352,9 @@ def test_release_workflow_uses_pypi_trusted_publishing() -> None:
     assert "\n  verify-distributions:\n" in release
     assert "tests/clean_install_smoke.py" in release
     assert "tests/test_live.py" in release
+    assert "SERPAPI_API_KEY: ${{ secrets.SERPAPI_API_KEY }}" in verify_distributions
+    assert "SERPAPI_KEY: ${{ secrets.SERPAPI_KEY }}" in verify_distributions
+    assert 'test -n "$SERPAPI_API_KEY" || test -n "$SERPAPI_KEY"' in verify_distributions
     assert 'python-version: "3.14"' in verify_distributions
     assert "\n  framework-tests:\n" in release
     assert "tox-environment:" in _workflow_job_text(release, "framework-tests")