Dk/scylla use metadata

.github/dependabot.yml

@@ -0,0 +1,9 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/docs"
+    schedule:
+      interval: "daily"
+    allow:
+      - dependency-name: "sphinx-scylladb-theme"
+      - dependency-name: "sphinx-multiversion-scylla"

.github/pull_request_template.md

@@ -0,0 +1,17 @@
+## Pre-review checklist
+
+<!--
+    Make sure you took care of the issues on the list.
+    Put 'x' into those boxes which apply.
+    You can also create the PR now and click on all relevant checkboxes.
+    See CONTRIBUTING.rst for more details.
+-->
+
+- [ ] I have split my patch into logically separate commits.
+- [ ] All commit messages clearly explain what they change and why.
+- [ ] I added relevant tests for new features and bug fixes.
+- [ ] All commits compile, pass static checks and pass test.
+- [ ] PR description sums up the changes and reasons why they should be introduced.
+- [ ] I have provided docstrings for the public items that I want to introduce.
+- [ ] I have adjusted the documentation in `./docs/source/`.
+- [ ] I added appropriate `Fixes:` annotations to PR description.

.github/workflows/build-pre-release.yml

@@ -0,0 +1,21 @@
+name: Test building on pre-release python version
+
+on:
+  workflow_dispatch:
+    inputs:
+      python-version:
+        description: 'Python version to run against'
+        required: true
+        type: string
+
+      target:
+        type: string
+        description: "target os to build for: linux,macos-x86,macos-arm,windows,linux-aarch64"
+        default: "linux,macos-x86,macos-arm,windows,linux-aarch64"
+
+jobs:
+  build-and-publish:
+    uses: ./.github/workflows/lib-build-and-push.yml
+    with:
+      python-version: ${{ inputs.python-version }}
+      target: ${{ inputs.target }}

.github/workflows/build-push.yml

@@ -1,155 +1,33 @@
 name: Build and upload to PyPi
 
-on: [push, pull_request]
-
-
-env:
- CIBW_TEST_COMMAND_LINUX: "pytest --import-mode append {project}/tests/unit -k 'not (test_connection_initialization or test_cloud)' && EVENT_LOOP_MANAGER=gevent pytest --import-mode append {project}/tests/unit/io/test_geventreactor.py && EVENT_LOOP_MANAGER=eventlet pytest --import-mode append {project}/tests/unit/io/test_eventletreactor.py "
- CIBW_TEST_COMMAND_MACOS: "pytest --import-mode append {project}/tests/unit -k 'not (test_multi_timer_validation or test_empty_connections or test_connection_initialization or test_timer_cancellation or test_cloud)' "
- CIBW_TEST_COMMAND_WINDOWS: "pytest --import-mode append {project}/tests/unit  -k \"not (test_deserialize_date_range_year or test_datetype or test_libevreactor or test_connection_initialization or test_cloud)\" "
- CIBW_BEFORE_TEST: "pip install -r {project}/test-requirements.txt pytest"
- CIBW_BEFORE_BUILD_LINUX: "rm -rf ~/.pyxbld && yum install -y libffi-devel libev libev-devel openssl openssl-devel"
- CIBW_ENVIRONMENT: "CASS_DRIVER_BUILD_CONCURRENCY=2"
- CIBW_SKIP: cp35* cp36* *musllinux*
+on:
+  push:
+    branches:
+      - master
+      - 'branch-**'
+  workflow_dispatch:
 
 jobs:
-  build_wheels:
-    name: Build wheels ${{ matrix.os }} (${{ matrix.platform }})
-    if: contains(github.event.pull_request.labels.*.name, 'test-build') || github.event_name == 'push' && endsWith(github.event.ref, 'scylla')
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: false
-      matrix:
-        include:
-          - os: ubuntu-latest
-            platform: x86_64
-
-          - os: ubuntu-latest
-            platform: i686
-
-          - os: ubuntu-latest
-            platform: PyPy
-
-          - os: windows-latest
-            platform: win32
-
-          - os: windows-latest
-            platform: win64
-
-          - os: windows-latest
-            platform: PyPy
-
-          - os: macos-latest
-            platform: all
-
-          - os: macos-latest
-            platform: PyPy
-
-    steps:
-      - uses: actions/checkout@v2
-
-      - uses: actions/setup-python@v2
-        name: Install Python
-
-      - name: Install cibuildwheel
-        run: |
-          python -m pip install cibuildwheel==2.3.0
-
-      - name: Install OpenSSL for Windows
-        if: runner.os == 'Windows'
-        run: |
-          choco install openssl -f -y
-
-      - name: Install OpenSSL for MacOS
-        if: runner.os == 'MacOs'
-        run: |
-          brew install libev
-
-      - name: Overwrite for Linux 64
-        if: runner.os == 'Linux' && matrix.platform == 'x86_64'
-        run: |
-          echo "CIBW_BUILD=cp3*_x86_64" >> $GITHUB_ENV
-
-      - name: Overwrite for Linux 32
-        if: runner.os == 'Linux' && matrix.platform == 'i686'
-        run: |
-          echo "CIBW_BUILD=cp*_i686" >> $GITHUB_ENV
-          echo "CIBW_TEST_COMMAND_LINUX=" >> $GITHUB_ENV
-
-      - name: Overwrite for Linux PyPy
-        if: runner.os == 'Linux' && matrix.platform == 'PyPy'
-        run: |
-          echo "CIBW_BUILD=pp*" >> $GITHUB_ENV
-          echo "CIBW_TEST_COMMAND_LINUX=" >> $GITHUB_ENV
-
-      - name: Overwrite for Windows 64
-        if: runner.os == 'Windows' && matrix.platform == 'win64'
-        run: |
-          echo "CIBW_BUILD=cp*win_amd64" | Out-File -FilePath $Env:GITHUB_ENV -Encoding utf-8 -Append
-
-      - name: Overwrite for Windows 32
-        if: runner.os == 'Windows' && matrix.platform == 'win32'
-        run: |
-          echo "CIBW_BUILD=cp*win32" | Out-File -FilePath $Env:GITHUB_ENV -Encoding utf-8 -Append
-
-      - name: Overwrite for Windows PyPY
-        if: runner.os == 'Windows' && matrix.platform == 'PyPy'
-        run: |
-          echo "CIBW_BUILD=pp*" | Out-File -FilePath $Env:GITHUB_ENV -Encoding utf-8 -Append
-          echo "CIBW_TEST_COMMAND_WINDOWS=" | Out-File -FilePath $Env:GITHUB_ENV -Encoding utf-8 -Append
-
-      - name: Overwrite for MacOs
-        if: runner.os == 'MacOs' && matrix.platform == 'all'
-        run: |
-          echo "CIBW_BUILD=cp37* cp38*" >> $GITHUB_ENV
-          echo "CIBW_BEFORE_TEST_MACOS=pip install -r {project}/test-requirements.txt pytest" >> $GITHUB_ENV
-
-      - name: Overwrite for MacOs PyPy
-        if: runner.os == 'MacOs' && matrix.platform == 'PyPy'
-        run: |
-          echo "CIBW_BUILD=pp*" >> $GITHUB_ENV
-          echo "CIBW_BEFORE_TEST_MACOS=pip install -r {project}/test-requirements.txt pytest" >> $GITHUB_ENV
-          echo "CIBW_TEST_COMMAND_MACOS=" >> $GITHUB_ENV
-
-      - name: Build wheels
-        run: |
-          python -m cibuildwheel --output-dir wheelhouse
-
-      - uses: actions/upload-artifact@v2
-        with:
-          path: ./wheelhouse/*.whl
-
-  build_sdist:
-    name: Build source distribution
-    if: contains(github.event.pull_request.labels.*.name, 'test-build') || github.event_name == 'push' && endsWith(github.event.ref, 'scylla')
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-
-      - uses: actions/setup-python@v2
-        name: Install Python
-
-      - name: Build sdist
-        run: python setup.py sdist
-
-      - uses: actions/upload-artifact@v2
-        with:
-          path: dist/*.tar.gz
-
-  upload_pypi:
-    needs: [build_wheels, build_sdist]
-    runs-on: ubuntu-latest
-    # upload to PyPI on every tag starting with 'v'
-    if: github.event_name == 'push' && endsWith(github.event.ref, 'scylla')
-    # alternatively, to publish when a GitHub Release is created, use the following rule:
-    # if: github.event_name == 'release' && github.event.action == 'published'
+  build-and-publish:
+    name: "Build wheels"
+    uses: ./.github/workflows/lib-build-and-push.yml
+    with:
+      upload: false
+
+  # TODO: Remove when https://github.com/pypa/gh-action-pypi-publish/issues/166 is fixed and update build-and-publish.with.upload to ${{ endsWith(github.event.ref, 'scylla') }}
+  publish:
+    name: "Publish wheels to PyPi"
+    if: ${{ endsWith(github.event.ref, 'scylla') }}
+    needs: build-and-publish
+    runs-on: ubuntu-24.04
+    permissions:
+      id-token: write
     steps:
-      - uses: actions/download-artifact@v2
+      - uses: actions/download-artifact@v4
         with:
-          name: artifact
           path: dist
+          merge-multiple: true
 
-      - uses: pypa/gh-action-pypi-publish@master
+      - uses: pypa/gh-action-pypi-publish@release/v1
         with:
-          user: __token__
-          password: ${{ secrets.PYPI_API_TOKEN }}
+          skip-existing: true

.github/workflows/build-test.yml

@@ -0,0 +1,23 @@
+name: Test wheels building
+
+on:
+  pull_request:
+    branches:
+      - master
+    paths-ignore:
+     - docs/*
+     - examples/*
+     - .gitignore
+     - '*.rst'
+     - '*.ini'
+     - LICENSE
+     - .github/dependabot.yml
+     - .github/pull_request_template.md
+
+jobs:
+  test-wheels-build:
+    name: "Test wheels building"
+    if: "!contains(github.event.pull_request.labels.*.name, 'disable-test-build')"
+    uses: ./.github/workflows/lib-build-and-push.yml
+    with:
+      upload: false

.github/workflows/docs-pages.yaml

@@ -0,0 +1,39 @@
+name: "Docs / Publish"
+# For more information,
+# see https://sphinx-theme.scylladb.com/stable/deployment/production.html#available-workflows
+
+on:
+  push:
+    branches:
+      - master
+      - 'branch-**'
+    paths:
+      - "docs/**"
+  workflow_dispatch:
+
+jobs:
+  release:
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.repository.default_branch }}
+          persist-credentials: false
+          fetch-depth: 0
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+      - name: Set up env
+        run: make -C docs setupenv
+      - name: Build driver
+        run: python setup.py develop
+      - name: Build docs
+        run: make -C docs multiversion
+      - name: Build redirects
+        run: make -C docs redirects
+      - name: Deploy docs to GitHub Pages
+        run: ./docs/_utils/deploy.sh
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}