Skip to content

genaumann/salt-git-formula

Repository files navigation

Salt Git Formula

GitHub release lint test

Install and configure git. Clone and update local git repositories.

General notes

See the full SaltStack Formulas installation and usage instructions.

See example.yml on how to configure the formula.

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.

Available states

git

Includes the following states:

  • git.install
  • git.repo
  • git.config

git.install

Installs git.

git.repo

Can clone, update and delete a local git repository. You can use this state to verify a local git repo is checked out on your system.

git.config

Includes the following states:

  • git.config.system
  • git.config.user

git.config.system

Ensure a system wide git config is set/unset.

git.config.user

Ensure a user wide git config is set/unset.

Testing

Linux testing is done with kitchen-salt.

All tests and lint jobs are executed in GitHub Actions.

Requirements

You can test the formula locally after installing the following requirements.

  • vagrant
  • VirtualBox
  • Ruby
  • bundler

Run Test

bundle install
kitchen list # list all available test instances
kitchen test <instance>

Known Errors

OS support matrix

This formula has been tested under the following operating systems and salt versions.

OS 3006.0 3006.5 3006.6 3006.7 3007.0
Debian 12
Ubuntu 22.04
Rocky 9
Fedora 38
OpenSUSE 15 Not released Not released Not released Not released