mirror of
https://github.com/saltstack-formulas/cron-formula.git
synced 2026-07-17 17:06:39 +02:00
semantic-release-bot
8cf0ec745a
## [0.3.2](https://github.com/saltstack-formulas/cron-formula/compare/v0.3.1...v0.3.2) (2020-09-10) ### Continuous Integration * **gemfile:** restrict `train` gem version until upstream fix [skip ci] ([ce61077](https://github.com/saltstack-formulas/cron-formula/commit/ce610777803fa67ce4e8aa4e01823741ec5844af)) * **gemfile.lock:** add to repo with updated `Gemfile` [skip ci] ([269b49f](https://github.com/saltstack-formulas/cron-formula/commit/269b49f38a304cf7ca63ae889f178a939353accd)) * **kitchen:** avoid using bootstrap for `master` instances [skip ci] ([0afa1b1](https://github.com/saltstack-formulas/cron-formula/commit/0afa1b10d2a4325880cfeda7f716d2eaf82edb4b)) * **kitchen:** use `saltimages` Docker Hub where available [skip ci] ([74999aa](https://github.com/saltstack-formulas/cron-formula/commit/74999aa17df28a7128058697f6b5f4a59ab468c6)) * **kitchen+travis:** remove `master-py2-arch-base-latest` [skip ci] ([54b5a1a](https://github.com/saltstack-formulas/cron-formula/commit/54b5a1abaad6b8a650ad48d1cee807c486e53c0b)) * **travis:** add notifications => zulip [skip ci] ([fb46b07](https://github.com/saltstack-formulas/cron-formula/commit/fb46b0799e4084a8b22f77d0c5c6b2179e20be01)) * **travis:** apply changes from build config validation [skip ci] ([730df10](https://github.com/saltstack-formulas/cron-formula/commit/730df1087fe44b7bc40bd9e2530188cb9c6ffcca)) * **travis:** opt-in to `dpl v2` to complete build config validation [skip ci] ([4fc3960](https://github.com/saltstack-formulas/cron-formula/commit/4fc3960112929de84d546e3547ce81f9685c5687)) * **travis:** quote pathspecs used with `git ls-files` [skip ci] ([0fef6f1](https://github.com/saltstack-formulas/cron-formula/commit/0fef6f12230e018b8c0402c80a2f2c98a1280ef9)) * **travis:** run `shellcheck` during lint job [skip ci] ([1b2eb28](https://github.com/saltstack-formulas/cron-formula/commit/1b2eb285a5bb62c86d6e7e64ddd76ce85a709d2b)) * **travis:** use `major.minor` for `semantic-release` version [skip ci] ([d4a6100](https://github.com/saltstack-formulas/cron-formula/commit/d4a610094969d583621cdec3195652508fe0aace)) * **travis:** use build config validation (beta) [skip ci] ([db46bd9](https://github.com/saltstack-formulas/cron-formula/commit/db46bd9c9008fddc3681602cf559513df3ee1976)) * **workflows/commitlint:** add to repo [skip ci] ([449c919](https://github.com/saltstack-formulas/cron-formula/commit/449c919f14dc295883de17db7b5b42dea1c56a2b)) ### Reverts * **codeowners:** update specific directories section [skip ci] ([2ac7785](https://github.com/saltstack-formulas/cron-formula/commit/2ac7785f6446abf26d8e9897e7a5898f5bb42d1b)) ### Styles * **state:** avoid complicated comparison ([496f09b](https://github.com/saltstack-formulas/cron-formula/commit/496f09b2e1c2ba88d8df95ec0c0011fce0d4a7a7))
.. _readme:
cron-formula
============
|img_travis| |img_sr|
.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/cron-formula.svg?branch=master
:alt: Travis CI Build Status
:scale: 100%
:target: https://travis-ci.com/saltstack-formulas/cron-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
Formula to set up and configure cron.
.. contents:: **Table of Contents**
General notes
-------------
See the full `SaltStack Formulas installation and usage instructions
<https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html>`_.
If you are interested in writing or contributing to formulas, please pay attention to the `Writing Formula Section
<https://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html#writing-formulas>`_.
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 `How to contribute <https://github.com/saltstack-formulas/.github/blob/master/CONTRIBUTING.rst>`_ for more details.
Available states
----------------
.. contents::
:local:
``cron``
^^^^^^^^
Installs and configures the cron package.
``cron.package``
^^^^^^^^^^^^^^^^
Installs the cron package.
``cron.config``
^^^^^^^^^^^^^^^
This state manages the file ``cron.conf`` under ``/etc/cron`` (template found in "cron/files"). The configuration is populated by values in "cron/map.jinja" based on the package's default values (and RedHat, Debian, Suse and Arch family distribution specific values), which can then be overridden by values of the same name in pillar.
``cron.service``
^^^^^^^^^^^^^^^^
Manage the ``cron`` service. Stopping or starting it. If needed, you can disable the cron service by setting the ``enabled: false`` option in the pillar.
Testing
-------
Linux testing is done with ``kitchen-salt``.
Requirements
^^^^^^^^^^^^
* 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 ``cron`` 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.