TEMPLATE-formula

Commit message formatting is significant!!

Please see How to contribute for more details.

pre-commit is configured for this formula, which you may optionally use to ease the steps involved in submitting your changes. First install the pre-commit package manager using the appropriate method, then run bin/install-hooks and now pre-commit will run automatically on each git commit. :

The easiest way to use this template formula as a base for a new formula is to use GitHub’s Use this template button to create a new repository. For consistency with the rest of the formula ecosystem, name your formula repository following the pattern <formula theme>-formula, where <formula theme> consists of lower-case alphabetic characters, numbers, '-' or '_'.

In the rest of this example we’ll use example as the <formula theme>.

Follow these steps to complete the conversion from template-formula to example-formula. :

Alternatively, it’s possible to clone template-formula into a new repository and perform the conversion there. For example:

To take advantage of semantic-release for automated changelog generation and release tagging, you will need a GitHub Personal Access Token with at least the public_repo scope.

In the Travis repository settings for your new repository, create an environment variable named GH_TOKEN with the personal access token as value, restricted to the master branch for security.

Note that this repository uses a CODEOWNERS file to assign ownership to various parts of the formula. The conversion process removes overall ownership, but you should consider assigning ownership to yourself or your organisation when contributing your new formula to the saltstack-formulas organisation.

Meta-state (This is a state that includes other states).

This installs the TEMPLATE package, manages the TEMPLATE configuration file and then starts the associated TEMPLATE service.

This state will install the TEMPLATE package only.

This state will configure the TEMPLATE service and has a dependency on TEMPLATE.install via include list.

This state will start the TEMPLATE service and has a dependency on TEMPLATE.config via include list.

Meta-state (This is a state that includes other states).

this state will undo everything performed in the TEMPLATE meta-state in reverse order, i.e. stops the service, removes the configuration file and then uninstalls the package.

This state will stop the TEMPLATE service and disable it at boot time.

This state will remove the configuration of the TEMPLATE service and has a dependency on TEMPLATE.service.clean via include list.

This state will remove the TEMPLATE package and has a depency on TEMPLATE.config.clean via include list.

Meta-state (This is a state that includes other states).

This state installs a subcomponent configuration file before configuring and starting the TEMPLATE service.

This state will configure the TEMPLATE subcomponent and has a dependency on TEMPLATE.config via include list.

This state will remove the configuration of the TEMPLATE subcomponent and reload the TEMPLATE service by a dependency on TEMPLATE.service.running via include list and watch_in requisite.

Where [platform] is the platform name defined in kitchen.yml, e.g. debian-9-2019-2-py3.

Creates the docker instance and runs the TEMPLATE main state, ready for testing.

Runs the inspec tests on the actual instance.

Removes the docker instance.

Runs all of the stages above in one go: i.e. destroy + converge
verify + destroy.

Gives you SSH access to the instance for manual testing.