From 46d2ff193c8105d4901201a44b875db228b289fb Mon Sep 17 00:00:00 2001 From: David Murphy Date: Mon, 9 Sep 2024 13:46:55 -0600 Subject: [PATCH] Clean use of copier update --trust using previous experience --- .copier-answers.yml | 7 +- .github/workflows/test.yml | 24 +++---- CODE-OF-CONDUCT.md | 127 ++++++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 14 ++++ NOTICE | 10 +++ README.md | 6 +- docs/conf.py | 6 +- docs/topics/installation.md | 8 --- noxfile.py | 2 +- pyproject.toml | 2 +- 10 files changed, 176 insertions(+), 30 deletions(-) create mode 100644 CODE-OF-CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 NOTICE diff --git a/.copier-answers.yml b/.copier-answers.yml index 2edc82f..8b42ba8 100644 --- a/.copier-answers.yml +++ b/.copier-answers.yml @@ -1,10 +1,13 @@ # Autogenerated. Do not edit this by hand, use `copier update`. --- -_commit: 0.3.5 +_commit: 0.3.7 _src_path: https://github.com/salt-extensions/salt-extension-copier author: David Murphy author_email: david-dm.murphy@broadcom.com +coc_contact: david-dm.murphy@broadcom.com +copyright_begin: 2024 docs_url: '' +integration_name: Cassandra license: apache loaders: - module @@ -14,7 +17,7 @@ no_saltext_namespace: false package_name: cassandra project_name: cassandra python_requires: '3.10' -salt_version: '3006' +salt_version: '3006.8' source_url: https://github.com/salt-extensions/saltext-cassandra ssh_fixtures: true summary: Salt Extension for interacting with Cassandra diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 374d519..5089bcc 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -70,10 +70,10 @@ jobs: max-parallel: 4 matrix: include: - - {salt-version: "3006", python-version: "3.10"} - - {salt-version: "3007", python-version: "3.10"} - - {salt-version: "3007", python-version: "3.11"} - - {salt-version: "3007", python-version: "3.12"} + - {salt-version: "3006.8", python-version: "3.10"} + - {salt-version: "3007.1", python-version: "3.10"} + ## - {salt-version: "3007", python-version: "3.11"} + ## - {salt-version: "3007", python-version: "3.12"} steps: - uses: actions/checkout@v4 @@ -193,10 +193,10 @@ jobs: max-parallel: 3 matrix: include: - - {salt-version: "3006", python-version: "3.10"} - - {salt-version: "3007", python-version: "3.10"} - - {salt-version: "3007", python-version: "3.11"} - - {salt-version: "3007", python-version: "3.12"} + - {salt-version: "3006.8", python-version: "3.10"} + - {salt-version: "3007.1", python-version: "3.10"} + ## - {salt-version: "3007", python-version: "3.11"} + ## - {salt-version: "3007", python-version: "3.12"} steps: - uses: actions/checkout@v4 @@ -321,10 +321,10 @@ jobs: max-parallel: 3 matrix: include: - - {salt-version: "3006", python-version: "3.10"} - - {salt-version: "3007", python-version: "3.10"} - - {salt-version: "3007", python-version: "3.11"} - - {salt-version: "3007", python-version: "3.12"} + - {salt-version: "3006.8", python-version: "3.10"} + - {salt-version: "3007.1", python-version: "3.10"} + ## - {salt-version: "3007", python-version: "3.11"} + ## - {salt-version: "3007", python-version: "3.12"} steps: - uses: actions/checkout@v4 diff --git a/CODE-OF-CONDUCT.md b/CODE-OF-CONDUCT.md new file mode 100644 index 0000000..4d2a5ef --- /dev/null +++ b/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 Cassandra 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 david-dm.murphy@broadcom.com. +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. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f9bc256 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,14 @@ +Thanks for your interest in contributing to the Salt Extension Modules for +Cassandra! 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 diff --git a/NOTICE b/NOTICE new file mode 100644 index 0000000..09b5064 --- /dev/null +++ b/NOTICE @@ -0,0 +1,10 @@ +Salt Extension Modules for Cassandra +Copyright 2024 David Murphy + +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. diff --git a/README.md b/README.md index 29f8352..acc2dad 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Salt Extension for interacting with Cassandra ## 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 @@ -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+Cassandra to solve your +* Posting on social media about how you used Salt + Cassandra 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! diff --git a/docs/conf.py b/docs/conf.py index feaa302..5f5cbd1 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -42,10 +42,10 @@ # -- Project information ----------------------------------------------------- this_year = datetime.datetime.today().year -if this_year == 2021: - copyright_year = 2021 +if this_year == 2024: + copyright_year = "2024" else: - copyright_year = f"2021 - {this_year}" + copyright_year = f"2024 - {this_year}" project = dist.metadata["Summary"] author = dist.metadata.get("Author") diff --git a/docs/topics/installation.md b/docs/topics/installation.md index d0c9c32..fa1401f 100644 --- a/docs/topics/installation.md +++ b/docs/topics/installation.md @@ -22,15 +22,7 @@ pip install saltext-cassandra ``` ::: -:::{important} -Currently, there is [an issue][issue-second-saltext] where the installation of a Saltext fails silently -if the environment already has another one installed. You can workaround this by -removing all Saltexts and reinstalling them in one transaction. -::: - :::{hint} Saltexts are not distributed automatically via the fileserver like custom modules, they need to be installed on each node you want them to be available on. ::: - -[issue-second-saltext]: https://github.com/saltstack/salt/issues/65433 diff --git a/noxfile.py b/noxfile.py index 70f9999..6cb9f3c 100755 --- a/noxfile.py +++ b/noxfile.py @@ -29,7 +29,7 @@ EXTRA_REQUIREMENTS_INSTALL = os.environ.get("EXTRA_REQUIREMENTS_INSTALL") COVERAGE_REQUIREMENT = os.environ.get("COVERAGE_REQUIREMENT") or "coverage==7.5.1" -SALT_REQUIREMENT = os.environ.get("SALT_REQUIREMENT") or "salt>=3006" +SALT_REQUIREMENT = os.environ.get("SALT_REQUIREMENT") or "salt>=3006.8" if SALT_REQUIREMENT == "salt==master": SALT_REQUIREMENT = "git+https://github.com/saltstack/salt.git@master" diff --git a/pyproject.toml b/pyproject.toml index 1c8facb..3a0dd96 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -35,7 +35,7 @@ classifiers = [ requires-python = ">= 3.10" dynamic = ["version"] dependencies = [ - "salt>=3006", + "salt>=3006.8", ] [project.readme]