Merge pull request #5 from dmurphy18/upd_from_copier

Update from copier using template 0.5.1

.codecov.yml

@@ -0,0 +1,25 @@
+---
+coverage:
+  status:
+    project:
+      default: false
+      app:
+        informational: true
+        paths:
+          - src/
+      tests:
+        informational: true
+        paths:
+          - tests/
+    patch:
+      default: false
+      app:
+        informational: true
+        paths:
+          - src/
+      tests:
+        informational: true
+        paths:
+          - tests/
+github_checks:
+  annotations: false

.copier-answers.yml

@@ -1,27 +1,32 @@
 # Autogenerated. Do not edit this by hand, use `copier update`.
 ---
-_commit: 0.3.7
+_commit: 0.5.1
 _src_path: https://github.com/salt-extensions/salt-extension-copier
 author: David Murphy
 author_email: [email protected]
 coc_contact: [email protected]
 copyright_begin: 2024
+deploy_docs: rolling
 docs_url: ''
 integration_name: Cassandra
 license: apache
 loaders:
   - module
   - returner
-max_salt_version: 3007.1
+max_salt_version: '3007'
 no_saltext_namespace: false
+os_support:
+  - Linux
+  - macOS
+  - Windows
 package_name: cassandra
 project_name: cassandra
 python_requires: '3.10'
+relax_pylint: false
 salt_version: '3006.8'
 source_url: https://github.com/salt-extensions/saltext-cassandra
 ssh_fixtures: true
 summary: Salt Extension for interacting with Cassandra
 test_containers: true
 tracker_url: https://github.com/salt-extensions/saltext-cassandra/issues
 url: https://github.com/salt-extensions/saltext-cassandra
-workflows: basic

.coveragerc

@@ -11,10 +11,7 @@ omit =
 
 [report]
 # Regexes for lines to exclude from consideration
-exclude_lines =
-    # Have to re-enable the standard pragma
-    pragma: no cover
-
+exclude_also =
     # Don't complain about missing debug-only code:
     def __repr__
 
@@ -26,12 +23,17 @@ exclude_lines =
     if 0:
     if False:
     if __name__ == .__main__.:
+    if TYPE_CHECKING:
+    @(abc\.)?abstractmethod
+
+    # Add markers which exclude statements in between.
+    # Requires coverage>=7.6.0.
+    no cover: start(?s:.)*?no cover: stop
 
 omit =
   .nox/*
   setup.py
 
-
 ignore_errors = True
 
 [paths]

.envrc

@@ -0,0 +1,7 @@
+layout_saltext() {
+    VIRTUAL_ENV="$(python3 tools/initialize.py --print-venv)"
+    PATH_add "$VIRTUAL_ENV/bin"
+    export VIRTUAL_ENV
+}
+
+layout_saltext

.github/workflows/ci.yml

@@ -0,0 +1,135 @@
+---
+name: CI
+
+on:
+  workflow_call:
+    inputs:
+      deploy-docs:
+        required: false
+        type: boolean
+        default: false
+      release:
+        required: false
+        type: boolean
+        default: false
+      version:
+        required: false
+        type: string
+    secrets:
+      PYPI_API_TOKEN:
+        required: false
+      TEST_PYPI_API_TOKEN:
+        required: false
+
+
+jobs:
+  get-changed-files:
+    name: Get Changed Files
+    uses: ./.github/workflows/get-changed-files.yml
+
+  pre-commit:
+    name: Pre-Commit
+    uses: ./.github/workflows/pre-commit-action.yml
+    needs:
+      - get-changed-files
+    with:
+      changed-files: ${{ needs.get-changed-files.outputs.changed-files }}
+
+  test:
+    name: Test
+    needs:
+      - pre-commit
+    uses: ./.github/workflows/test-action.yml
+
+  docs:
+    name: Docs
+    needs:
+      - pre-commit
+    uses: ./.github/workflows/docs-action.yml
+
+  deploy-docs:
+    name: Deploy Docs
+    uses: ./.github/workflows/deploy-docs-action.yml
+    # Only build doc deployments from the default branch of the repo and never for PRs.
+    if: >-
+      github.event_name != 'pull_request' &&
+      inputs.deploy-docs &&
+      github.ref == format('refs/heads/{0}', github.event.repository.default_branch)
+    needs:
+      - docs
+      - test
+
+  build-python-package:
+    name: Python Package
+    if: ${{ inputs.release && success() }}
+    uses: ./.github/workflows/package-action.yml
+    needs:
+      - pre-commit
+    with:
+      version: "${{ inputs.version }}"
+
+  deploy-python-package-test-pypi:
+    name: Deploy Python Package (Test PyPI)
+    uses: ./.github/workflows/deploy-package-action.yml
+    if: ${{ inputs.release && success() }}
+    needs:
+      - test
+      - docs
+      - build-python-package
+    secrets:
+      TEST_PYPI_API_TOKEN: "${{ secrets.TEST_PYPI_API_TOKEN }}"
+    with:
+      version: "${{ inputs.version }}"
+
+  deploy-python-package:
+    name: Deploy Python Package (PyPI)
+    uses: ./.github/workflows/deploy-package-action.yml
+    if: ${{ inputs.release && success() }}
+    needs:
+      - deploy-python-package-test-pypi
+    secrets:
+      PYPI_API_TOKEN: "${{ secrets.PYPI_API_TOKEN }}"
+    with:
+      test: false
+      version: "${{ inputs.version }}"
+
+  set-pipeline-exit-status:
+    # This step is just so we can make github require this step, to pass checks
+    # on a pull request instead of requiring all
+    name: Set the CI Pipeline Exit Status
+    runs-on: ubuntu-24.04
+    if: always()
+    needs:
+      - test
+      - docs
+      - deploy-docs
+      - build-python-package
+      - deploy-python-package-test-pypi
+      - deploy-python-package
+
+    steps:
+      - name: Download Exit Status Files
+        if: always()
+        uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16  # v4.1.8
+        with:
+          path: exitstatus
+          pattern: exitstatus-*
+          merge-multiple: true
+
+      - name: Delete Exit Status Artifacts
+        if: always()
+        uses: geekyeggo/delete-artifact@7ee91e82b4a7f3339cd8b14beace3d826a2aac39  # v5.1.0
+        with:
+          name: exitstatus-*
+          useGlob: true
+          failOnError: false
+
+      - name: Set Pipeline Exit Status
+        run: |
+          tree exitstatus
+          grep -RE 'failure|cancelled' exitstatus/ && exit 1 || exit 0
+
+      - name: Done
+        if: always()
+        run:
+          echo "All workflows finished"

.github/workflows/deploy-docs-action.yml

@@ -0,0 +1,78 @@
+---
+name: Publish Documentation
+
+on:
+  workflow_call:
+    inputs:
+      # This is the name of the regular artifact that should
+      # be transformed into a GitHub Pages deployment.
+      artifact-name:
+        type: string
+        required: false
+        default: html-docs
+
+jobs:
+
+  # The released docs are not versioned currently, only the latest ones are deployed.
+  #
+  # Versioning support would require either (better):
+  #   * Rebuilding docs for all versions when a new release is made
+  #   * Version selector support in `furo`: https://github.com/pradyunsg/furo/pull/500
+  #
+  # or (more basic):
+  #   * using the `gh-pages` branch and peaceiris/actions-gh-pages
+  #     to be able to deploy to subdirectories. The implementation via
+  #     actions/deploy-pages always replaces the directory root.
+
+  Deploy-Docs-GH-Pages:
+    name: Publish Docs to GitHub Pages
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    permissions:
+      pages: write
+      id-token: write
+
+    runs-on: ubuntu-24.04
+
+    steps:
+      - name: Download built docs
+        uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16  # v4.1.8
+        with:
+          name: ${{ inputs.artifact-name }}
+          path: html-docs
+
+      - name: Upload GitHub Pages artifact
+        uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa  # v3.0.1
+        with:
+          name: html-docs-pages
+          path: html-docs
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e  # v4.0.5
+        with:
+          artifact_name: html-docs-pages
+
+      - name: Delete GitHub Pages artifact
+        if: always()
+        uses: geekyeggo/delete-artifact@7ee91e82b4a7f3339cd8b14beace3d826a2aac39  # v5.1.0
+        with:
+          name: html-docs-pages
+          failOnError: false
+
+      - name: Set Exit Status
+        if: always()
+        run: |
+          mkdir exitstatus
+          echo "${{ job.status }}" > exitstatus/${{ github.job }}
+
+      - name: Upload Exit Status
+        if: always()
+        uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882  # v4.4.3
+        with:
+          name: exitstatus-${{ github.job }}
+          path: exitstatus
+          if-no-files-found: error

.github/workflows/deploy-package-action.yml

@@ -0,0 +1,54 @@
+---
+name: Deploy Salt Extension Python Package
+
+on:
+  workflow_call:
+    inputs:
+      test:
+        type: boolean
+        required: false
+        default: true
+      version:
+        type: string
+        required: true
+    secrets:
+      PYPI_API_TOKEN:
+        required: false
+      TEST_PYPI_API_TOKEN:
+        required: false
+
+jobs:
+  build:
+    name: Publish Python Package to ${{ fromJSON('["PyPI", "Test PyPI"]')[inputs.test] }}
+    runs-on: ubuntu-24.04
+
+    steps:
+      - name: Download Python Package Artifacts
+        uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16  # v4.1.8
+        with:
+          name: salt-extension-${{ inputs.version }}-packages
+          path: dist
+
+      - name: Publish distribution to Test PyPI
+        uses: pypa/gh-action-pypi-publish@c44d2f0e52f028349e3ecafbf7f32561da677277  # v1.10.3
+        if: ${{ inputs.test }}
+        with:
+          password: ${{ secrets.TEST_PYPI_API_TOKEN }}
+          repository-url: https://test.pypi.org/legacy/
+
+      - name: Create GitHub Release
+        if: ${{ !inputs.test }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh release create "$GITHUB_REF_NAME" \
+              --repo="$GITHUB_REPOSITORY" \
+              --title="${GITHUB_REPOSITORY#*/} ${{ inputs.version }}" \
+              --generate-notes \
+              dist/*
+
+      - name: Publish distribution to PyPI
+        uses: pypa/gh-action-pypi-publish@c44d2f0e52f028349e3ecafbf7f32561da677277  # v1.10.3
+        if: ${{ !inputs.test }}
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}