Skip to content

Commit e04413e

Browse files
committed
docs(readme): add testing requirements section (from vault-formula)
* https://github.com/saltstack-formulas/vault-formula/blob/43dc95d/docs/README.rst#requirements
1 parent dca7888 commit e04413e

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

docs/README.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,21 @@ Testing
104104

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

107+
Requirements
108+
^^^^^^^^^^^^
109+
110+
* Ruby
111+
* Docker
112+
113+
.. code-block:: bash
114+
115+
$ gem install bundler
116+
$ bundle install
117+
$ bundle exec kitchen test [platform]
118+
119+
Where ``[platform]`` is the platform name defined in ``kitchen.yml``,
120+
e.g. ``debian-9-2019-2-py3``.
121+
107122
``kitchen converge``
108123
^^^^^^^^^^^^^^^^^^^^
109124

0 commit comments

Comments
 (0)