Merge pull request #10 from lkubb/copier-update

.copier-answers.yml

@@ -1,10 +1,14 @@
 # Autogenerated. Do not edit this by hand, use `copier update`.
 ---
-_commit: 0.2.7
+_commit: 0.3.7
 _src_path: https://github.com/lkubb/salt-extension-copier
 author: EITR Technologies, LLC
 author_email: devops@eitr.tech
-docs_url: ''
+coc_contact: devops@eitr.tech
+copyright_begin: 2024
+deploy_docs: rolling
+docs_url: https://salt-extensions.github.io/saltext-redis/
+integration_name: Redis
 license: apache
 loaders:
   - cache
@@ -15,7 +19,7 @@ loaders:
   - sdb
   - state
   - token
-max_salt_version: 3006
+max_salt_version: 3007
 no_saltext_namespace: false
 package_name: redis
 project_name: redis
@@ -24,6 +28,7 @@ salt_version: '3005'
 source_url: https://github.com/salt-extensions/saltext-redis
 ssh_fixtures: false
 summary: Salt Extension for interacting with Redis
+test_containers: true
 tracker_url: https://github.com/salt-extensions/saltext-redis/issues
 url: https://github.com/salt-extensions/saltext-redis
 workflows: org

.github/workflows/pr.yml

@@ -12,6 +12,10 @@ jobs:
   call_central_workflow:
     name: CI
     uses: salt-extensions/central-artifacts/.github/workflows/ci.yml@main
+    with:
+      deploy-docs: true
     permissions:
       contents: write
+      id-token: write
+      pages: write
       pull-requests: read

.github/workflows/tag.yml

@@ -16,16 +16,18 @@ jobs:
 
       - name: Extract tag name
         id: get_version
-        run: echo "::set-output name=version::$(echo ${GITHUB_REF#refs/tags/v})"
+        run: echo "version=$(echo ${GITHUB_REF#refs/tags/v})" >> $GITHUB_OUTPUT
 
   call_central_workflow:
     needs: get_tag_version
     uses: salt-extensions/central-artifacts/.github/workflows/ci.yml@main
     with:
+      deploy-docs: true
       release: true
       version: ${{ needs.get_tag_version.outputs.version }}
     permissions:
       contents: write
       id-token: write
+      pages: write
       pull-requests: read
     secrets: inherit

.pre-commit-config.yaml

@@ -2,7 +2,7 @@
 minimum_pre_commit_version: 2.4.0
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.6.0
     hooks:
       - id: check-merge-conflict  # Check for files that contain merge conflict strings.
       - id: trailing-whitespace   # Trims trailing whitespace.
@@ -56,7 +56,7 @@ repos:
         args: [--silent, -E, fix_docstrings]
 
   - repo: https://github.com/asottile/pyupgrade
-    rev: v2.37.2
+    rev: v3.15.2
     hooks:
       - id: pyupgrade
         name: Rewrite Code to be Py3.8+
@@ -65,43 +65,43 @@ repos:
         ]
         exclude: src/saltext/redis/version.py
 
-  - repo: https://github.com/asottile/reorder_python_imports
-    rev: v3.10.0
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.13.2
     hooks:
-      - id: reorder-python-imports
+      - id: isort
         args: [
-          --py38-plus,
+          --py 38,
         ]
-        exclude: src/saltext/redis/version.py
+        exclude: src/saltext/redis/(__init__|version).py
 
   - repo: https://github.com/psf/black
-    rev: 22.6.0
+    rev: 24.2.0
     hooks:
       - id: black
         args: [-l 100]
         exclude: src/saltext/redis/version.py
 
   - repo: https://github.com/adamchainz/blacken-docs
-    rev: v1.12.1
+    rev: 1.16.0
     hooks:
       - id: blacken-docs
         args: [--skip-errors]
         files: ^(docs/.*\.rst|src/saltext/redis/.*\.py)$
         additional_dependencies:
-          - black==22.6.0
+          - black==24.2.0
   # <---- Formatting -----------------------------------------------------------------------------
 
   # ----- Security ------------------------------------------------------------------------------>
   - repo: https://github.com/PyCQA/bandit
-    rev: "1.7.4"
+    rev: 1.7.8
     hooks:
       - id: bandit
         alias: bandit-salt
         name: Run bandit against the code base
         args: [--silent, -lll, --skip, B701]
         exclude: src/saltext/redis/version.py
   - repo: https://github.com/PyCQA/bandit
-    rev: "1.7.4"
+    rev: 1.7.8
     hooks:
       - id: bandit
         alias: bandit-tests
@@ -112,7 +112,7 @@ repos:
 
   # ----- Code Analysis ------------------------------------------------------------------------->
   - repo: https://github.com/saltstack/mirrors-nox
-    rev: v2021.6.12
+    rev: v2022.11.21
     hooks:
       - id: nox
         alias: lint-src
@@ -125,7 +125,7 @@ repos:
           - --
 
   - repo: https://github.com/saltstack/mirrors-nox
-    rev: v2021.6.12
+    rev: v2022.11.21
     hooks:
       - id: nox
         alias: lint-tests

.pre-commit-hooks/make-autodocs.py

@@ -3,7 +3,6 @@
 import subprocess
 from pathlib import Path
 
-
 repo_path = Path(subprocess.check_output(["git", "rev-parse", "--show-toplevel"]).decode().strip())
 src_dir = repo_path / "src" / "saltext" / "redis"
 doc_dir = repo_path / "docs"

CODE-OF-CONDUCT.md

@@ -0,0 +1,127 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in Salt
+Extension Modules for Redis project and our community a
+harassment-free experience for everyone, regardless of age, body size, visible
+or invisible disability, ethnicity, sex characteristics, gender identity and
+expression, level of experience, education, socio-economic status, nationality,
+personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at devops@eitr.tech.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,14 @@
+Thanks for your interest in contributing to the Salt Extension Modules for
+Redis! We welcome any contribution, large or small - from
+adding a new feature to fixing a single letter typo.
+
+This is a companion to the Salt Project and the [Salt Contributing
+Guide][salt-contributing] should be considered the default for this project.
+Where this project disagrees with the Salt Project, the guidelines here take
+precedence. Where this project is silent, the Salt guidelines should be used.
+
+See the **Contributing** section in the [README][README.md] for a quickstart.
+
+
+[README.md]: README.md
+[salt-contributing]: https://docs.saltproject.io/en/master/topics/development/contributing.html

NOTICE

@@ -0,0 +1,10 @@
+Salt Extension Modules for Redis
+Copyright 2024 EITR Technologies, LLC
+
+This product is licensed to you under the Apache 2.0 license (the "License").
+You may not use this product except in compliance with the Apache 2.0 License.
+
+This product may include a number of subcomponents with separate copyright
+notices and license terms. Your use of these subcomponents is subject to the
+terms and conditions of the subcomponent's license, as noted in the LICENSE
+file.

README.md

@@ -4,14 +4,14 @@ Salt Extension for interacting with Redis
 
 ## Security
 
-If you think you've found a security vulnerability, see
+If you think you have found a security vulnerability, see
 [Salt's security guide][security].
 
 ## User Documentation
 
 This README is for people aiming to contribute to the project.
 If you just want to get started with the extension, check out the
-module docstrings (for now, documentation is coming!).
+[User Documentation][docs].
 
 ## Contributing
 
@@ -64,11 +64,11 @@ these areas:
 You could also contribute in other ways:
 
 * Writing blog posts
-* Posting on social media about how you used Salt+Redis to solve your
+* Posting on social media about how you used Salt + Redis to solve your
   problems, including videos
 * Giving talks at conferences
 * Publishing videos
-* Asking/answering questions in IRC, Slack, or email groups
+* Asking/answering questions in IRC, Discord or email groups
 
 Any of these things are super valuable to our community, and we sincerely
 appreciate every contribution!
@@ -84,3 +84,4 @@ that's where you'll find the rest of the documentation.
 [PRs]: https://github.com/salt-extensions/saltext-redis/pulls
 [discussions]: https://github.com/salt-extensions/saltext-redis/discussions
 [comments]: https://conventionalcomments.org/
+[docs]: https://salt-extensions.github.io/saltext-redis/

docs/_ext/saltdomain.py

@@ -0,0 +1,18 @@
+"""
+Copied/distilled from Salt doc/_ext/saltdomain.py in order to be able
+to use Salt's custom doc refs.
+"""
+
+
+def setup(app):
+    app.add_crossref_type(
+        directivename="conf_master",
+        rolename="conf_master",
+        indextemplate="pair: %s; conf/master",
+    )
+    app.add_crossref_type(
+        directivename="conf_minion",
+        rolename="conf_minion",
+        indextemplate="pair: %s; conf/minion",
+    )
+    return {"parallel_read_safe": True, "parallel_write_safe": True}