Salt/timezone-formula
0
0
Fork 0
mirror of https://github.com/saltstack-formulas/timezone-formula.git synced 2024-11-27 23:07:47 +01:00
Code Issues Activity
0e2da3600c
timezone-formula/docs
History
semantic-release-bot dea1d0d92b chore(release): 0.4.3 [skip ci] 
## [0.4.3](https://github.com/saltstack-formulas/timezone-formula/compare/v0.4.2...v0.4.3) (2020-03-24)

### Bug Fixes

* ensure formula works across all platforms ([ff66e5f](ff66e5fd10))
* **release.config.js:** use full commit hash in commit link [skip ci] ([9a77727](9a77727e0c))

### Continuous Integration

* **gemfile:** restrict `train` gem version until upstream fix [skip ci] ([17c50f0](17c50f0dc6))
* **kitchen:** avoid using bootstrap for `master` instances [skip ci] ([d3245cc](d3245cc104))
* **kitchen:** use `debian-10-master-py3` instead of `develop` [skip ci] ([ff64318](ff643188e1))
* **kitchen:** use `develop` image until `master` is ready (`amazonlinux`) [skip ci] ([7e89450](7e8945033e))
* **kitchen+travis:** adjust matrix to add `3000` & remove `2017.7` ([e2301d5](e2301d5c2f))
* **kitchen+travis:** upgrade matrix after `2019.2.2` release [skip ci] ([88c3cab](88c3cabd7d))
* **travis:** apply changes from build config validation [skip ci] ([438aeb2](438aeb2ddc))
* **travis:** opt-in to `dpl v2` to complete build config validation [skip ci] ([01b751e](01b751e122))
* **travis:** quote pathspecs used with `git ls-files` [skip ci] ([a1c8254](a1c82549d4))
* **travis:** run `shellcheck` during lint job [skip ci] ([1996629](1996629c72))
* **travis:** update `salt-lint` config for `v0.0.10` [skip ci] ([201a23b](201a23b23c))
* **travis:** use `major.minor` for `semantic-release` version [skip ci] ([2a79489](2a79489fa7))
* **travis:** use build config validation (beta) [skip ci] ([d2dbc29](d2dbc29153))

### Documentation

* **contributing:** remove to use org-level file instead [skip ci] ([58900e1](58900e1705))
* **readme:** update link to `CONTRIBUTING` [skip ci] ([84ebbe0](84ebbe0d0f))

### Performance Improvements

* **travis:** improve `salt-lint` invocation [skip ci] ([18a7452](18a74520ef))
2020-03-24 14:12:54 +00:00
..
AUTHORS.rst chore(release): 0.4.3 [skip ci] 2020-03-24 14:12:54 +00:00
CHANGELOG.rst chore(release): 0.4.3 [skip ci] 2020-03-24 14:12:54 +00:00
README.rst docs(readme): update link to CONTRIBUTING [skip ci] 2019-10-14 11:39:27 +01:00

README.rst 

.. _readme:

timezone-formula
================

|img_travis| |img_sr|

.. |img_travis| image:: https://travis-ci.com/saltstack-formulas/timezone-formula.svg?branch=master
   :alt: Travis CI Build Status
   :scale: 100%
   :target: https://travis-ci.com/saltstack-formulas/timezone-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 timezone.

.. 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:

``timezone``
^^^^^^^^^^^^
Installs and configures the timezone package.

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 ``timezone`` 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.