Skip to content

Commit

Permalink
Merge pull request #1 from dmurphy18/copier-update
Browse files Browse the repository at this point in the history
Updates from updated copier template
  • Loading branch information
dmurphy18 authored Sep 9, 2024
2 parents 2cb9f47 + 6895593 commit 88be709
Show file tree
Hide file tree
Showing 9 changed files with 179 additions and 33 deletions.
9 changes: 6 additions & 3 deletions .copier-answers.yml
Original file line number Diff line number Diff line change
@@ -1,20 +1,23 @@
# 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: [email protected]
coc_contact: [email protected]
copyright_begin: 2024
docs_url: ''
integration_name: Cassandra
license: apache
loaders:
- module
- returner
max_salt_version: 3007
max_salt_version: 3007.1
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
Expand Down
28 changes: 14 additions & 14 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: 3.10
python-version: "3.10"
- name: Set Cache Key
run: echo "PY=$(python --version --version | sha256sum | cut -d' ' -f1)" >> $GITHUB_ENV
- name: Install System Deps
Expand All @@ -36,7 +36,7 @@ jobs:
- name: Set up Python 3.10 For Nox
uses: actions/setup-python@v5
with:
python-version: 3.10
python-version: "3.10"

- name: Install Nox
run: |
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ repos:
language: system
pass_filenames: false

- repo: https://github.com/s0undt3ch/salt-rewrite
- repo: https://github.com/saltstack/salt-rewrite
# Automatically rewrite code with known rules
rev: 2.5.2
hooks:
Expand All @@ -45,7 +45,7 @@ repos:
files: ^src/saltext/cassandra/.*\.py$
args: [--silent]

- repo: https://github.com/s0undt3ch/salt-rewrite
- repo: https://github.com/saltstack/salt-rewrite
# Automatically rewrite code with known rules
rev: 2.5.2
hooks:
Expand Down
127 changes: 127 additions & 0 deletions CODE-OF-CONDUCT.md
Original file line number Diff line number Diff line change
@@ -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 [email protected].
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.
14 changes: 14 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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
10 changes: 10 additions & 0 deletions NOTICE
Original file line number Diff line number Diff line change
@@ -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.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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!
Expand Down
6 changes: 3 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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")

Expand Down
8 changes: 0 additions & 8 deletions docs/topics/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 88be709

Please sign in to comment.