Salt Extension for MySQL

Salt Extension for interacting with MySQL

Security

If you discover a security vulnerability, please refer to Salt's security guide.

User Documentation

For setup and usage instructions, please refer to the User Documentation.

Contributing

The saltext-mysql project welcomes contributions from anyone!

The Salt Extensions guide provides comprehensive instructions on all aspects of Salt extension development, including writing tests, running tests, writing documentation and rendering the docs.

Quickstart

To get started contributing, first clone this repository (or your fork):

# Clone the repo
git clone --origin upstream git@github.com:salt-extensions/saltext-mysql.git

# Change to the repo dir
cd saltext-mysql

Automatic

If you have installed direnv, copying the included .envrc.example to .envrc and allowing it to run ensures a proper development environment is present and the virtual environment is active.

Without direnv, you can still run the automation explicitly:

make dev  # or python3 tools/initialize.py
source .venv/bin/activate

Manual

Please follow the first steps, skipping the repository initialization and first commit.

Pull request

Always make changes in a feature branch:

git switch -c my-feature-branch

Please ensure you include a news fragment describing your changes. This is a requirement for all user-facing changes (bug fixes, new features), with the exception of documentation changes.

To submit a Pull Request, you'll need a fork of this repository in your own GitHub account. If you followed the instructions above, set your fork as the origin remote now:

git remote add origin git@github.com:<your_fork>.git

Ensure you followed the first steps and commit your changes, fixing any failing pre-commit hooks. Then push the feature branch to your fork and submit a PR.

Ways to contribute

Contributions come in many forms, and they’re all valuable! Here are some ways you can help without writing code:

• Documentation: Especially examples showing how to use this project to solve specific problems.
• Triaging issues: Help manage issues and participate in discussions.
• Reviewing Pull Requests: We especially appreciate reviews using Conventional Comments.

You can also contribute by:

• Writing blog posts
• Sharing your experiences using Salt + MySQL on social media
• Giving talks at conferences
• Publishing videos
• Engaging in IRC, Discord or email groups

Any of these things are super valuable to our community, and we sincerely appreciate every contribution!