Fork 0
mirror of synced 2024-05-29 13:21:10 -04:00
Imran Iqbal 8af3849f1c chore: use semantic-release cross-formula standard structure
* Automated using `ssf-formula` (v0.1.0-rc.1)
2019-07-19 13:38:21 +01:00
AUTHORS.rst chore(release): 0.21.1 [skip ci] 2019-05-29 21:24:47 +00:00
CHANGELOG.rst chore(release): 0.21.1 [skip ci] 2019-05-29 21:24:47 +00:00
CONTRIBUTING.rst chore: use semantic-release cross-formula standard structure 2019-07-19 13:38:21 +01:00
README.rst docs: fix CONTRIBUTING and README 2019-05-29 19:50:49 +01:00

.. _readme:


|img_travis| |img_sr|

.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/sudoers-formula.svg?branch=master
   :alt: Travis CI Build Status
   :scale: 100%
   :target: https://travis-ci.com/saltstack-formulas/sudoers-formula
.. |img_sr| image:: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
   :alt: Semantic Release
   :scale: 100%
   :target: https://github.com/semantic-release/semantic-release

Set up ``sudo`` and the ``sudoers`` included files.

.. contents:: **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 <http://semver.org/>`_.

See `Formula Versioning Section <https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html#versioning>`_ for more details.

Contributing to this repo

**Commit message formatting is significant!!**

Please see :ref:`How to contribute <CONTRIBUTING>` for more details.

Available states

.. contents::


Set up the sudoers file


Set up an additional sudoers included file


Linux testing is done with ``kitchen-salt``.


* Ruby
* Docker

.. code-block:: bash

   $ gem install bundler
   $ bundle install
   $ bin/kitchen test [platform]

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

``bin/kitchen converge``

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

``bin/kitchen verify``

Runs the ``inspec`` tests on the actual instance.

``bin/kitchen destroy``

Removes the docker instance.

``bin/kitchen test``

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

``bin/kitchen login``

Gives you SSH access to the instance for manual testing.