From ebfffcde8fdbe4fb8bb9bd7f7810ed3ce29096f9 Mon Sep 17 00:00:00 2001 From: Imran Iqbal Date: Sat, 3 Aug 2019 14:34:27 +0100 Subject: [PATCH] docs(readme): add initial `Using this repo` section --- docs/README.rst | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/docs/README.rst b/docs/README.rst index 697b894f..9fc6c1c9 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -15,7 +15,7 @@ ssf-formula :target: https://github.com/semantic-release/semantic-release A SaltStack formula that is used to manage other SaltStack formulas, -particularly those that involve `semantic-release`, TOFS and `inspec`-based testing. +particularly those that involve ``semantic-release``, TOFS and/or InSpec-based testing. .. contents:: **Table of Contents** @@ -40,6 +40,27 @@ Contributing to this repo Please see :ref:`How to contribute ` for more details. +Using this repo +--------------- + +Due to the nature of the ``git`` operations used by this formula, +there are assumptions made about the local configuration: + +#. Each repo has two remotes and tracking branches such as provided by the `git fork + `_ + command (available in the ``git-extras`` package). + +#. A GitHub token is available, with the relevant permissions to create pull requests for each formula. + + a. This token needs to be provided in the custom script, as mentioned in the `pillar.example + `_ + file. + #. The custom script is defined in the pillar/config. + +However, pull requests (for each formula) should not be submitted until the changes are reviewed and merged here first. +When testing changes locally, use the pillar/config settings as `recommended +`_. + Available states ----------------