ssf-formula
A SaltStack formula that is used to manage other SaltStack formulas,
particularly those that involve semantic-release, TOFS and/or InSpec-based testing.
Table of Contents
General notes
See the full SaltStack Formulas installation and usage instructions.
If you are interested in writing or contributing to formulas, please pay attention to the Writing Formula Section.
If you want to use this formula, please pay attention to the FORMULA file and/or git tag,
which contains the currently released version. This formula is versioned according to Semantic Versioning.
See Formula Versioning Section for more details.
Contributing to this repo
Commit message formatting is significant!!
Please see How to contribute for more details.
Using this repo
Due to the nature of the git operations used by this formula,
there are assumptions made about the local configuration:
- Each repo has two remotes and tracking branches such as provided by the git fork
command (available in the
git-extraspackage). - A GitHub token is available, with the relevant permissions to create pull requests for each formula.
- This token needs to be provided in the custom script, as mentioned in the pillar.example file.
- The custom script is defined in the pillar/config.
However, pull requests (for each formula) should not be submitted until the changes are reviewed and merged here first. When testing changes locally, use the pillar/config settings as recommended.
Available states
ssf
Meta-state (This is a state that includes other states).
This runs the ssf.config state.
ssf.config
This state will work through the pillar/config-based activated formulas and files, to prepare the changes that are necessary since the last sync. The actual steps that are taken depend on the values set in the pillar/config. These can result in making local changes only, or even pushing to GitHub and creating the PR automatically.
Testing
This is scheduled for an upcoming release.