docs(semantic-release): implement an automated changelog

plus docs on contributing, testing
Eric Veiras Galisson 3 years ago
parent 7cec4c0bb3
commit b73af20fe8
  1. 10
  2. 44
  3. 106
  4. 3
  5. 161
  6. 124
  7. 443
  8. 30
  9. 18
  10. 106

.gitignore vendored

@ -102,3 +102,13 @@ ENV/
# mypy
# Bundler
# copied `.md` files used for conversion to `.rst` using `m2r`
# Vim

@ -1,3 +1,9 @@
- test
- commitlint
- name: release
if: branch = master AND type != pull_request
sudo: required
cache: bundler
language: ruby
@ -5,9 +11,8 @@ language: ruby
- docker
- bundle install
# Make sure the instances listed below match up with
# the `platforms` defined in `kitchen.yml`
- INSTANCE: v2019-2-py3-debian-9
@ -27,3 +32,36 @@ env:
- bundle exec kitchen verify ${INSTANCE}
# Define the commitlint stage
- stage: commitlint
language: node_js
node_js: lts/*
before_install: skip
- npm install @commitlint/config-conventional -D
- npm install @commitlint/travis-cli -D
- commitlint-travis
# Define the release stage that runs semantic-release
- stage: release
language: node_js
node_js: lts/*
before_install: skip
# Update ``
- go get
- maintainer contributor
# Install all dependencies required for `semantic-release`
- npm install @semantic-release/changelog@3 -D
- npm install @semantic-release/exec@3 -D
- npm install @semantic-release/git@7 -D
provider: script
skip_cleanup: true
# Run `semantic-release`
- npx semantic-release@15

@ -1,106 +0,0 @@
# Authors
This list is sorted by the number of commits per contributor in descending order.
* [@aboe76](
* [@gravyboat](
* [@nmadhok](
* [@iggy](
* [@puneetk](
* [@xenophonf](
* [@andrew-vant](
* [@javierbertoli](
* [@whiteinge](
* [@rhertzog](
* [@pcdummy](
* [@babilen5](
* [@UtahDave](
* [@myii](
* [@colin-stubbs](
* [@techhat](
* [@bradthurber](
* [@fizmat](
* [@thatch45](
* [@msciciel](
* [@genuss](
* [@jacksoncage](
* [@mrichar1](
* [@noelmcloughlin](
* [@0xf10e](
* [@EvaSDK](
* [@jbouse](
* [@mattwillsher](
* [@tampakrap](
* [@dafyddj](
* [@jcftang](
* [@johtso](
* [@kev009](
* [@MSeven](
* [@excavador](
* [@vquiering](
* [@smlloyd](
* [@cackovic](
* [@AntoineCezar](
* [@auser](
* [@cmclaughlin](
* [@raizyr](
* [@basepi](
* [@quixoten](
* [@pprkut](
* [@hemebond](
* [@centromere](
* [@jerrykan](
* [@kevinschmidt](
* [@MrMarvin](
* [@stp-ip](
* [@iamseth](
* [@Quarky9](
* [@thomaslarsen](
* [@tibold](
* [@tobias-m](
* [@ek9](
* [@tiger-seo](
* [@matthew-parlette](
* [@alxwr](
* [@aanriot](
* [@alejdg](
* [@ernstae](
* [@Angelo-Verona](
* [@arthurlogilab](
* [@kakwa](
* [@danielfrg](
* [@blast-hardcheese](
* [@mecavity](
* [@terminalmage](
* [@felix-russell](
* [@Furlot](
* [@iondulgheru](
* [@iustinam](
* [@txomon](
* [@jebas](
* [@t0fik](
* [@kyrias](
* [@sjorge](
* [@Linuturk](
* [@jtriley](
* [@msonawane](
* [@Oro](
* [@mwpher](
* [@mnaser](
* [@vermut](
* [@ralucasg](
* [@robruma](
* [@spoage](
* [@mogman1](
* [@Thor77](
* [@TiagoTT](
* [@highlyunavailable](
* [@westurner](
* [@abednarik](
* [@jpic](
* [@kabakaev](
* [@mechleg](
* [@ze42](
* [@bersace](
###### Auto generated by [gaocegege/maintainer]( on 2019-02-13

@ -0,0 +1,3 @@
module.exports = {
extends: ['@commitlint/config-conventional'],

@ -0,0 +1,161 @@
.. _contributing:
How to contribute
This document will eventually outline all aspects of guidance to make your contributing experience a fruitful and enjoyable one.
What it already contains is information about *commit message formatting* and how that directly affects the numerous automated processes that are used for this repo.
It also covers how to contribute to this *formula's documentation*.
.. contents:: **Table of Contents**
Submitting a pull request is more than just code!
To achieve a quality product, the *tests* and *documentation* need to be updated as well.
An excellent pull request will include these in the changes, wherever relevant.
Commit message formatting
Since every type of change requires making Git commits,
we will start by covering the importance of ensuring that all of your commit
messages are in the correct format.
Automation of multiple processes
This formula uses `semantic-release <>`_ for automating numerous processes such as bumping the version number appropriately, creating new tags/releases and updating the changelog.
The entire process relies on the structure of commit messages to determine the version bump, which is then used for the rest of the automation.
Full details are available in the upstream docs regarding the `Angular Commit Message Conventions <>`_.
The key factor is that the first line of the commit message must follow this format:
.. code-block::
type(scope): subject
* E.g. ``docs(contributing): add commit message formatting instructions``.
Besides the version bump, the changelog and release notes are formatted accordingly.
So based on the example above:
.. raw:: html
* **contributing:** add commit message formatting instructions
* The ``type`` translates into a ``Documentation`` sub-heading.
* The ``(scope):`` will be shown in bold text without the brackets.
* The ``subject`` follows the ``scope`` as standard text.
Linting commit messages in Travis CI
This formula uses `commitlint <>`_ for checking commit messages during CI testing.
This ensures that they are in accordance with the ``semantic-release`` settings.
For more details about the default settings, refer back to the ``commitlint`` `reference rules <>`_.
Relationship between commit type and version bump
This formula applies some customisations to the defaults, as outlined in the table below,
based upon the `type <>`_ of the commit:
.. list-table::
:name: commit-type-vs-version-bump
:header-rows: 1
:stub-columns: 0
:widths: 1,2,3,1,1
* - Type
- Heading
- Description
- Bump (default)
- Bump (custom)
* - ``build``
- Build System
- Changes related to the build system
- –
* - ``chore``
- –
- Changes to the build process or auxiliary tools and libraries such as
documentation generation
- –
* - ``ci``
- Continuous Integration
- Changes to the continuous integration configuration
- –
* - ``docs``
- Documentation
- Documentation only changes
- –
- 0.0.1
* - ``feat``
- Features
- A new feature
- 0.1.0
* - ``fix``
- Bug Fixes
- A bug fix
- 0.0.1
* - ``perf``
- Performance Improvements
- A code change that improves performance
- 0.0.1
* - ``refactor``
- Code Refactoring
- A code change that neither fixes a bug nor adds a feature
- –
- 0.0.1
* - ``revert``
- Reverts
- A commit used to revert a previous commit
- –
- 0.0.1
* - ``style``
- Styles
- Changes that do not affect the meaning of the code (white-space,
formatting, missing semi-colons, etc.)
- –
- 0.0.1
* - ``test``
- Tests
- Adding missing or correcting existing tests
- –
- 0.0.1
Use ``BREAKING CHANGE`` to trigger a ``major`` version change
Adding ``BREAKING CHANGE`` to the footer of the extended description of the commit message will **always** trigger a ``major`` version change, no matter which type has been used.
This will be appended to the changelog and release notes as well.
To preserve good formatting of these notes, the following format is prescribed:
* ``BREAKING CHANGE: <explanation in paragraph format>.``
An example of that:
.. code-block:: git
BREAKING CHANGE: With the removal of all of the `.sls` files under
`template package`, this formula no longer supports the installation of

@ -1,96 +1,122 @@
.. _readme:
.. image::
|img_travis| |img_sr|
.. |img_travis| image::
:alt: Travis CI Build Status
:scale: 100%
.. |img_sr| image::
:alt: Semantic Release
:scale: 100%
Yes, Salt can Salt itself!
.. note::
.. 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 <>`_.
See `Formula Versioning Section <>`_ for more details.
See the full `Salt Formulas installation and usage instructions
Contributing to this repo
**Commit message formatting is significant!!**
Please see :ref:`How to contribute <CONTRIBUTING>` for more details.
Available states
.. contents::
Install a minion
Install a master.
Install a syndic.
Install salt cloud.
Install salt-ssh with roster file.
Configure pillar data under salt:ssh_roster to feed the template.
Install salt api
Requisite: Configure salt-master with rest_cherrypy or rest_tornado.
Install a minion and configure it in `standalone mode
Install gitfs backend dulwich dependencies. Set ``salt:master:gitfs_provider: dulwich`` in your pillar.
Install gitfs backend GitPython dependenciess. Set ``salt:master:gitfs_provider: gitpython`` in your pillar.
Install ssh keys to be used by gitfs
Install gitfs backend libgit2/pygit2 dependenciess. Set ``salt:master:gitfs_provider: pygit2`` in your pillar.
For EL distributions, pygit is installed from packages from `EPEL <>`_.
Enable the official saltstack package repository in order to always
benefit from the latest version. This state currently only works on Debian, Ubuntu, RHEL 6/7 and aims to implement the `installation recommendations of the official documentation <>`_.
Undo the effects of ``salt.pkgrepo``.
Clone selected `Salt formulas
@ -122,8 +148,10 @@ If you configure the state to download the formulas from repositories that
you control, then you can safely enable the
``salt_formulas:git_opts:default:update`` pillar setting to ``True``.
Every option available in the templates can be set in pillar. Settings under 'salt' will be overridden by more specific settings under ``salt['master']``, ``salt['minion']`` or ``salt['cloud']``. Options specified in ``salt['minion']`` which are not present in the default configuration file will be added to the end of the configuration file.
@ -140,12 +168,13 @@ Every option available in the templates can be set in pillar. Settings under 'sa
providers: ec2
Additional templates can be added by the user under salt/files/minion.d and master.d. This might be useful if, for example, a recently-added configuration option is not yet provided by the default template.
Executing the provided `Vagrantfile <>`_ will create a Ubuntu 14.04 VM, add the default Saltstack Repository and install the current stable version.
@ -153,8 +182,8 @@ The folders inside the VM will be set up in a way that enables you to simply exe
Remember, you will have to run ``state.highstate`` or ``state.sls salt.(master|minion|cloud)`` manually.
``MacOS Support``
MacOS Support
As MacOS has no native package management that pkg.installed can leverage appropriately, and brew does not count, the salt.minion state manages salt minion package upgrades by way of .pkg file download which is then installed using the macpackage.installed state.
@ -171,3 +200,34 @@ install_packages must indicate that the installation of a package is desired. If
A future update to the formula may include extraction of version from the downloaded .pkg itself; but for the time being you MUST set version to indicate what you believe it to be.
Refer to pillar.example for more information.
Linux testing is done with ``kitchen-salt``.
``kitchen converge``
Creates the docker instance and runs the ``template`` main state, ready for testing.
``kitchen verify``
Runs the ``inspec`` tests on the actual instance.
``kitchen destroy``
Removes the docker instance.
``kitchen test``
Runs all of the stages above in one go: i.e. ``destroy`` + ``converge`` + ``verify`` + ``destroy``.
``kitchen login``
Gives you SSH access to the instance for manual testing.

@ -0,0 +1,443 @@
.. _tofs_pattern:
TOFS: A pattern for using SaltStack
.. list-table::
:name: tofs-authors
:header-rows: 1
:stub-columns: 1
:widths: 2,2,3,2
* -
- Person
- Contact
- Date
* - Authored by
- Roberto Moreda
- 29/12/2014
* - Modified by
- Daniel Dehennin
- 07/02/2019
* - Modified by
- Imran Iqbal
- 23/02/2019
All that follows is a proposal based on my experience with `SaltStack <>`_. The good thing of a piece of software like this is that you can "bend it" to suit your needs in many possible ways, and this is one of them. All the recommendations and thoughts are given "as it is" with no warranty of any type.
.. contents:: **Table of Contents**
Usage of values in pillar vs templates in ``file_roots``
Among other functions, the *master* (or *salt-master*) serves files to the *minions* (or *salt-minions*). The `file_roots <>`_ is the list of directories used in sequence to find a file when a minion requires it: the first match is served to the minion. Those files could be `state files <>`_ or configuration templates, among others.
Using SaltStack is a simple and effective way to implement configuration management, but even in a `non-multitenant <>`_ scenario, it is not a good idea to generally access some data (e.g. the database password in our `Zabbix <>`_ server configuration file or the private key of our `Nginx <>`_ TLS certificate).
To avoid this situation we can use the `pillar mechanism <>`_, which is designed to provide controlled access to data from the minions based on some selection rules. As pillar data could be easily integrated in the `Jinja <>`_ templates, it is a good mechanism to store values to be used in the final rendering of state files and templates.
There are a variety of approaches on the usage of pillar and templates as seen in the `saltstack-formulas <>`_' repositories. `Some <>`_ `developments <>`_ stress the initial purpose of pillar data into a storage for most of the possible variables for a determined system configuration. This, in my opinion, is shifting too much load from the original template files approach. Adding up some `non-trivial Jinja <>`_ code as essential part of composing the state file definitely makes SaltStack state files (hence formulas) more difficult to read. The extreme of this approach is that we could end up with a new render mechanism, implemented in Jinja, storing everything needed in pillar data to compose configurations. Additionally, we are establishing a strong dependency with the Jinja renderer.
In opposition to the *put the code in file_roots and the data in pillars* approach, there is the *pillar as a store for a set of key-values* approach. A full-blown configuration file abstracted in pillar and jinja is complicated to develop, understand and maintain. I think a better and simpler approach is to keep a configuration file templated using just a basic (non-extensive but extensible) set of pillar values.
On the reusability of SaltStack state files
There is a brilliant initiative of the SaltStack community called `salt-formulas <>`_. Their goal is to provide state files, pillar examples and configuration templates ready to be used for provisioning. I am a contributor for two small ones: `zabbix-formula <>`_ and `varnish-formula <>`_.
The `design guidelines <>`_ for formulas are clear in many aspects and it is a recommended reading for anyone willing to write state files, even non-formulaic ones.
In the next section, I am going to describe my proposal to extend further the reusability of formulas, suggesting some patterns of usage.
The Template Override and Files Switch (TOFS) pattern
I understand a formula as a **complete, independent set of SaltStack state and configuration template files sufficient to configure a system**. A system could be something as simple as an NTP server or some other much more complex service that requires many state and configuration template files.
The customization of a formula should be done mainly by providing pillar data used later to render either the state or the configuration template files.
Example: NTP before applying TOFS
Let's work with the NTP example. A basic formula that follows the `design guidelines <>`_ has the following files and directories tree:
.. code-block::
In order to use it, let's assume a `masterless configuration <>`_ and this relevant section of ``/etc/salt/minion``:
.. code-block:: yaml
- /srv/saltstack/pillar
file_client: local
- /srv/saltstack/salt
- /srv/saltstack/salt-formulas/ntp-saltstack-formula
.. code-block:: jinja
{#- /srv/saltstack/salt-formulas/ntp-saltstack-formula/ntp/map.jinja #}
{%- set ntp = salt['grains.filter_by']({
'default': {
'pkg': 'ntp',
'service': 'ntp',
'config': '/etc/ntp.conf',
}, merge=salt['pillar.get']('ntp:lookup')) %}
In ``init.sls`` we have the minimal states required to have NTP configured. In many cases ``init.sls`` is almost equivalent to an ``apt-get install`` or a ``yum install`` of the package.
.. code-block:: sls
## /srv/saltstack/salt-formulas/ntp-saltstack-formula/ntp/init.sls
{%- from 'ntp/map.jinja' import ntp with context %}
Install NTP:
- name: {{ ntp.pkg }}
Enable and start NTP:
- name: {{ ntp.service }}
- enabled: True
- require:
- pkg: Install NTP package
In ``conf.sls`` we have the configuration states. In most cases, that is just managing configuration file templates and making them to be watched by the service.
.. code-block:: sls
## /srv/saltstack/salt-formulas/ntp-saltstack-formula/ntp/conf.sls
- ntp
{%- from 'ntp/map.jinja' import ntp with context %}
Configure NTP:
- name: {{ ntp.config }}
- template: jinja
- source: salt://ntp/files/default/etc/ntp.conf.jinja
- watch_in:
- service: Enable and start NTP service
- require:
- pkg: Install NTP package
Under ``files/default``, there is a structure that mimics the one in the minion in order to avoid clashes and confusion on where to put the needed templates. There you can find a mostly standard template for the configuration file.
.. code-block:: jinja
{#- /srv/saltstack/salt-formulas/ntp-saltstack-formula/ntp/files/default/etc/ntp.conf.jinja #}
{#- Managed by saltstack #}
{#- Edit pillars or override this template in saltstack if you need customization #}
{%- set settings = salt['pillar.get']('ntp', {}) %}
{%- set default_servers = ['',
''] %}
driftfile /var/lib/ntp/ntp.drift
statistics loopstats peerstats clockstats
filegen loopstats file loopstats type day enable
filegen peerstats file peerstats type day enable
filegen clockstats file clockstats type day enable
{%- for server in settings.get('servers', default_servers) %}
server {{ server }}
{%- endfor %}
restrict -4 default kod notrap nomodify nopeer noquery
restrict -6 default kod notrap nomodify nopeer noquery
restrict ::1
With all this, it is easy to install and configure a simple NTP server by just running ``salt-call state.sls ntp.conf``: the package will be installed, the service will be running and the configuration should be correct for most of cases, even without pillar data.
Alternatively, you can define a highstate in ``/srv/saltstack/salt/top.sls`` and run ``salt-call state.highstate``.
.. code-block:: sls
## /srv/saltstack/salt/top.sls
- ntp.conf
**Customizing the formula just with pillar data**, we have the option to define the NTP servers.
.. code-block:: sls
## /srv/saltstack/pillar/top.sls
- ntp
.. code-block:: sls
## /srv/saltstack/pillar/ntp.sls
Template Override
If the customization based on pillar data is not enough, we can override the template by creating a new one in ``/srv/saltstack/salt/ntp/files/default/etc/ntp.conf.jinja``
.. code-block:: jinja
{#- /srv/saltstack/salt/ntp/files/default/etc/ntp.conf.jinja #}
{#- Managed by saltstack #}
{#- Edit pillars or override this template in saltstack if you need customization #}
{#- Some bizarre configurations here #}
{#- ... #}
{%- for server in settings.get('servers', default_servers) %}
server {{ server }}
{%- endfor %}
This way we are locally **overriding the template files** offered by the formula in order to make a more complex adaptation. Of course, this could be applied as well to any of the files, including the state files.
Files Switch
To bring some order into the set of template files included in a formula, as we commented, we suggest having a similar structure to a normal final file system under ``files/default``.
We can make different templates coexist for different minions, classified by any `grain <>`_ value, by simply creating new directories under ``files``. This mechanism is based on **using values of some grains as a switch for the directories under** ``files/``.
If we decide that we want ``os_family`` as switch, then we could provide the formula template variants for both the ``RedHat`` and ``Debian`` families.
.. code-block::
To make this work we need a ``conf.sls`` state file that takes a list of possible files as the configuration template.
.. code-block:: sls
## /srv/saltstack/salt-formulas/ntp-saltstack-formula/ntp/conf.sls
- ntp
{%- from 'ntp/map.jinja' import ntp with context %}
Configure NTP:
- name: {{ ntp.config }}
- template: jinja
- source:
- salt://ntp/files/{{ grains.get('os_family', 'default') }}/etc/ntp.conf.jinja
- salt://ntp/files/default/etc/ntp.conf.jinja
- watch_in:
- service: Enable and start NTP service
- require:
- pkg: Install NTP package
If we want to cover the possibility of a special template for a minion identified by ``node01`` then we could have a specific template in ``/srv/saltstack/salt/ntp/files/node01/etc/ntp.conf.jinja``.
.. code-block:: jinja
{#- /srv/saltstack/salt/ntp/files/node01/etc/ntp.conf.jinja #}
{#- Managed by saltstack #}
{#- Edit pillars or override this template in saltstack if you need customization #}
{#- Some crazy configurations here for node01 #}
{#- ... #}
To make this work we could write a specially crafted ``conf.sls``.
.. code-block:: sls
## /srv/saltstack/salt-formulas/ntp-saltstack-formula/ntp/conf.sls
- ntp
{%- from 'ntp/map.jinja' import ntp with context %}
Configure NTP:
- name: {{ ntp.config }}
- template: jinja
- source:
- salt://ntp/files/{{ grains.get('id') }}/etc/ntp.conf.jinja
- salt://ntp/files/{{ grains.get('os_family') }}/etc/ntp.conf.jinja
- salt://ntp/files/default/etc/ntp.conf.jinja
- watch_in:
- service: Enable and start NTP service
- require:
- pkg: Install NTP package
Using the ``files_switch`` macro
We can simplify the ``conf.sls`` with the new ``files_switch`` macro to use in the ``source`` parameter for the ``file.managed`` state.
.. code-block:: sls
## /srv/saltstack/salt-formulas/ntp-saltstack-formula/ntp/conf.sls
- ntp
{%- set tplroot = tpldir.split('/')[0] %}
{%- from 'ntp/map.jinja' import ntp with context %}
{%- from 'ntp/libtofs.jinja' import files_switch %}
Configure NTP:
- name: {{ ntp.config }}
- template: jinja
- source: {{ files_switch(['/etc/ntp.conf.jinja'],
lookup='Configure NTP'
- watch_in:
- service: Enable and start NTP service
- require:
- pkg: Install NTP package
* This uses ``config.get``, searching for ``ntp:tofs:source_files:Configure NTP`` to determine the list of template files to use.
* If this does not yield any results, the default of ``['/etc/ntp.conf.jinja']`` will be used.
In ``libtofs.jinja``, we define this new macro ``files_switch``.
.. literalinclude:: ../template/libtofs.jinja
:caption: /srv/saltstack/salt-formulas/ntp-saltstack-formula/ntp/libtofs.jinja
:language: jinja
How to customise the ``source`` further
The examples below are based on an ``Ubuntu`` minion called ``theminion`` being configured via. pillar.
Using the default settings of the ``files_switch`` macro above,
the ``source`` will be:
.. code-block:: sls
- source:
- salt://ntp/files/theminion/etc/ntp.conf.jinja
- salt://ntp/files/Debian/etc/ntp.conf.jinja
- salt://ntp/files/default/etc/ntp.conf.jinja
Customise ``files``
The ``files`` portion can be customised:
.. code-block:: sls
files: files_alt
Resulting in:
.. code-block:: sls
- source:
- salt://ntp/files_alt/theminion/etc/ntp.conf.jinja
- salt://ntp/files_alt/Debian/etc/ntp.conf.jinja
- salt://ntp/files_alt/default/etc/ntp.conf.jinja
Customise the use of grains
Grains can be customised and even arbitrary paths can be supplied:
.. code-block:: sls
- any/path/can/be/used/here
- id
- os
- os_family
Resulting in:
.. code-block:: sls
- source:
- salt://ntp/files/any/path/can/be/used/here/etc/ntp.conf.jinja
- salt://ntp/files/theminion/etc/ntp.conf.jinja
- salt://ntp/files/Ubuntu/etc/ntp.conf.jinja
- salt://ntp/files/Debian/etc/ntp.conf.jinja
- salt://ntp/files/default/etc/ntp.conf.jinja
Customise the ``default`` path
The ``default`` portion of the path can be customised:
.. code-block:: sls
default: default_alt
Resulting in:
.. code-block:: sls
- source:
- salt://ntp/files/default_alt/etc/ntp.conf.jinja
Customise the list of ``source_files``
The list of ``source_files`` can be given:
.. code-block:: sls
Configure NTP:
- '/etc/ntp.conf.jinja'
- '/etc/ntp.conf_alt.jinja'
Resulting in:
.. code-block:: sls
- source:
- salt://ntp/files/theminion/etc/ntp.conf.jinja
- salt://ntp/files/theminion/etc/ntp.conf_alt.jinja
- salt://ntp/files/Debian/etc/ntp.conf.jinja
- salt://ntp/files/Debian/etc/ntp.conf_alt.jinja
- salt://ntp/files/default/etc/ntp.conf.jinja
- salt://ntp/files/default/etc/ntp.conf_alt.jinja

@ -0,0 +1,30 @@
# (A) Update `FORMULA` with `${nextRelease.version}`
sed -i -e "s_^\(version:\).*_\1 ${1}_" FORMULA
# (B) Use `m2r` to convert automatically produced `.md` docs to `.rst`
# Install `m2r`
sudo -H pip install m2r
# Copy and then convert the `.md` docs
cp *.md docs/
cd docs/
m2r --overwrite *.md
# Change excess `H1` headings to `H2` in converted `CHANGELOG.rst`
sed -i -e '/^=.*$/s/=/-/g' CHANGELOG.rst
sed -i -e '1,4s/-/=/g' CHANGELOG.rst
# Use for debugging output, when required
# cat AUTHORS.rst
# cat CHANGELOG.rst
# Return back to the main directory
cd ..

@ -0,0 +1,18 @@
// No release is triggered for the types commented out below.
// Commits using these types will be incorporated into the next release.
// NOTE: Any changes here must be reflected in ``.
module.exports = [
{breaking: true, release: 'major'},
// {type: 'build', release: 'patch'},
// {type: 'chore', release: 'patch'},
// {type: 'ci', release: 'patch'},
{type: 'docs', release: 'patch'},
{type: 'feat', release: 'minor'},
{type: 'fix', release: 'patch'},
{type: 'perf', release: 'patch'},
{type: 'refactor', release: 'patch'},
{type: 'revert', release: 'patch'},
{type: 'style', release: 'patch'},
{type: 'test', release: 'patch'},

@ -0,0 +1,106 @@
module.exports = {
branch: 'master',
plugins: [
['@semantic-release/commit-analyzer', {
preset: 'angular',
releaseRules: './release-rules.js',
['@semantic-release/changelog', {
changelogFile: '',
changelogTitle: '# Changelog',
['@semantic-release/exec', {
prepareCmd: 'sh ./ ${nextRelease.version}',
['@semantic-release/git', {
assets: ['*.md', 'docs/*.rst', 'FORMULA'],
generateNotes: {
preset: 'angular',
writerOpts: {
// Required due to upstream bug preventing all types being displayed.
// Bug:
// Fix:
transform: (commit, context) => {
const issues = []
commit.notes.forEach(note => {
note.title = `BREAKING CHANGES`
// NOTE: Any changes here must be reflected in ``.
if (commit.type === `feat`) {
commit.type = `Features`
} else if (commit.type === `fix`) {
commit.type = `Bug Fixes`
} else if (commit.type === `perf`) {
commit.type = `Performance Improvements`
} else if (commit.type === `revert`) {
commit.type = `Reverts`
} else if (commit.type === `docs`) {
commit.type = `Documentation`
} else if (commit.type === `style`) {
commit.type = `Styles`
} else if (commit.type === `refactor`) {
commit.type = `Code Refactoring`
} else if (commit.type === `test`) {
commit.type = `Tests`
} else if (commit.type === `build`) {
commit.type = `Build System`
// } else if (commit.type === `chore`) {
// commit.type = `Maintenance`
} else if (commit.type === `ci`) {
commit.type = `Continuous Integration`
} else {
if (commit.scope === `*`) {
commit.scope = ``
if (typeof commit.hash === `string`) {
commit.hash = commit.hash.substring(0, 7)
if (typeof commit.subject === `string`) {
let url = context.repository
? `${}/${context.owner}/${context.repository}`
: context.repoUrl
if (url) {
url = `${url}/issues/`
// Issue URLs.
commit.subject = commit.subject.replace(/#([0-9]+)/g, (_, issue) => {
return `[#${issue}](${url}${issue})`
if ( {
// User URLs.
commit.subject = commit.subject.replace(/\B@([a-z0-9](?:-?[a-z0-9/]){0,38})/g, (_, username) => {
if (username.includes('/')) {
return `@${username}`
return `[@${username}](${}/${username})`
// remove references that already appear in the subject
commit.references = commit.references.filter(reference => {
if (issues.indexOf(reference.issue) === -1) {
return true
return false
return commit