Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(authors): update automatically alongside semantic-release #42

Merged
merged 2 commits into from
Feb 23, 2019

Conversation

myii
Copy link
Member

@myii myii commented Feb 22, 2019

  • https://github.com/gaocegege/maintainer
    • The existing AUTHORS.md was created manually using this CLI app.
    • This commit automates this process to run during the CI build, as part of the overall semantic-release process.
  • https://github.com/myii/maintainer
    • Using an enhanced, forked version of this app.
    • The authors are now shown in a table rather than a bulleted list.

This PR is effectively complete but I've marked it WIP to get some confirmations before merging. The main issue is the use of the forked version rather than the (unmaintained) upstream version. To keep things simple, compare the end results for each:

Should the fork be a SaltStack-Formulas repo? Should it even be used at all?

Beyond that, there's also the question of documentation. One of the purposes of this file is to help identify the maintainers of each repo. Is this worth mentioning specifically, say in the CONTRIBUTING file?

@myii
Copy link
Member Author

myii commented Feb 22, 2019

The CLI app needs access to an environment variable, to access the GitHub API for getting the data.

However, the build is failing by design:

Encrypted environment variables have been removed for security reasons.
See https://docs.travis-ci.com/user/pull-requests/#pull-requests-and-security-restrictions

That link explains:

A pull request sent from a fork of the upstream repository could be manipulated to expose environment variables. The upstream repository’s maintainer would have no protection against this attack, as pull requests can be sent by anyone who forks the repository on GitHub.

Travis CI makes encrypted variables and data available only to pull requests coming from the same repository. These are considered trustworthy, as only members with write access to the repository can send them.

Pull requests sent from forked repositories do not have access to encrypted variables or data.

So one of two things here:

  1. Continue as usual and it should be OK once part of the repo itself, rather than a PR branch.
  2. Redo this PR from within the repo directly.

I reckon the first idea is fine and the second is overkill.

@aboe76
Copy link
Member

aboe76 commented Feb 22, 2019

@myii I'm fine with the forked version, looks good, and it will make it easier to see who's helping out on the formula's and getting in touch with each other.

@myii
Copy link
Member Author

myii commented Feb 22, 2019

@aboe76 Thanks for the feedback. Shall I keep the forked repo in my account or should we transfer it under SaltStack Formulas? Is the license OK for that in the first place?

Ready to merge once we finalise this point.

@aboe76
Copy link
Member

aboe76 commented Feb 22, 2019

@myii I see no issues with the license it's default apache 2.0 so there are no issues as long as it public.
but maybe saltstack would like to have it under a different organisation....

@myii
Copy link
Member Author

myii commented Feb 22, 2019 via email

* https://github.com/gaocegege/maintainer
  - The existing `AUTHORS.md` was created manually using this CLI app.
  - This commit automates this process to run during the CI build,
    as part of the overall `semantic-release` process.
* https://github.com/myii/maintainer
  - Using an enhanced, forked version of this app.
  - The authors are now shown in a table rather than a bulleted list.
@myii myii changed the title WIP: feat(authors): update automatically alongside semantic-release feat(authors): update automatically alongside semantic-release Feb 23, 2019
@myii myii merged commit f03dd6f into saltstack-formulas:master Feb 23, 2019
@myii myii deleted the PR_auto-authors branch February 23, 2019 00:52
@myii myii removed the WIP label Feb 23, 2019
@saltstack-formulas-travis

🎉 This PR is included in version 0.4.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

myii added a commit to myii/test-travis-ci that referenced this pull request Feb 24, 2019
* The `release` stage will always fail due to security reasons:
  - E.g. https://travis-ci.com/saltstack-formulas/template-formula/jobs/180068519#L466.
  - Discussed: saltstack-formulas/template-formula#42 (comment).
* The `release` stage is unnecessary, in any case.
myii added a commit that referenced this pull request Feb 24, 2019
* The `release` stage will always fail due to security reasons:
  - E.g. https://travis-ci.com/saltstack-formulas/template-formula/jobs/180068519#L466.
  - Discussed: #42 (comment).
* The `release` stage is unnecessary for PRs until the merge to `master`, in any case.
myii pushed a commit to myii/test-travis-ci that referenced this pull request Feb 24, 2019
## [1.1.5](v1.1.4...v1.1.5) (2019-02-24)

### Continuous Integration

* **travis:** prevent `release` stage running for PRs ([8be509d](8be509d)), closes [/travis-ci.com/saltstack-formulas/template-formula/jobs/180068519#L466](https://github.com//travis-ci.com/saltstack-formulas/template-formula/jobs/180068519/issues/L466) [/github.com/saltstack-formulas/template-formula/pull/42#issuecomment-466446324](https://github.com//github.com/saltstack-formulas/template-formula/pull/42/issues/issuecomment-466446324)
* **travis:** use `node_js` ([13874d4](13874d4))

### Documentation

* **readme:** add TOC delimiters and initial introduction ([8931a20](8931a20))
saltstack-formulas-travis pushed a commit that referenced this pull request Feb 24, 2019
## [0.7.2](v0.7.1...v0.7.2) (2019-02-24)

### Code Refactoring

* **tpldir:** use `tpldir` or derivatives to make formula portable ([52d03d8](52d03d8)), closes [#22](#22)

### Continuous Integration

* **kitchen:** improve comments about `opensuse` problems encountered ([c246939](c246939))
* **travis:** prevent `release` stage running for PRs ([3a072c7](3a072c7)), closes [/travis-ci.com/saltstack-formulas/template-formula/jobs/180068519#L466](https://github.com//travis-ci.com/saltstack-formulas/template-formula/jobs/180068519/issues/L466) [/github.com//pull/42#issuecomment-466446324](https://github.com//github.com/saltstack-formulas/template-formula/pull/42/issues/issuecomment-466446324)
myii pushed a commit to myii/template-formula that referenced this pull request Feb 28, 2019
# [1.0.0](v0.2.0...v1.0.0) (2019-02-28)

### Bug Fixes

* **pillar:** fix `os_family` typo ([3f89c12](3f89c12))
* **tofs:** update comments in `files_switch` macro for new method ([3fa3640](3fa3640))
* **tofs:** use `tpldir` derivative `topdir` for pillar (config) paths ([5e9df00](5e9df00))

### Code Refactoring

* **components:** split components into separate subdirs ([d957055](d957055)), closes [/github.com/saltstack-formulas/pull/48#pullrequestreview-207182085](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/pullrequestreview-207182085) [/github.com/saltstack-formulas/pull/48#discussion_r259805312](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259805312)
* **include+require:** use variable for duplicate values ([4443518](4443518))
* **kitchen:** prefer `kitchen.yml` to `.kitchen.yml` ([3860bf9](3860bf9))
* **macros:** use `tplroot` instead of `topdir` to match `tpldata` ([923b459](923b459))
* **pkg:** change to `package` instead ([2cd82e5](2cd82e5)), closes [/github.com/saltstack-formulas/pull/48#discussion_r259951123](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259951123)
* **pkg:** move `pkg` related components into separate directory ([c21f82b](c21f82b))
* **states:** set state IDs based on a dependable structure ([6690ee6](6690ee6)), closes [/github.com/saltstack-formulas/pull/48#discussion_r259953473](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259953473) [/github.com/saltstack-formulas/pull/48#discussion_r259956996](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259956996)
* **topdir:** use for `include` and `require` except `init.sls` ([a218e91](a218e91))
* **tpldir:** use `topdir` globally in place of `tpldir` ([2838bc9](2838bc9))
* **tpldir:** use `tpldir` or derivatives to make formula portable ([52d03d8](52d03d8)), closes [saltstack-formulas#22](https://github.com/myii/template-formula/issues/22)
* **tplroot:** use `tplroot` instead of `topdir` to match `tpldata` ([b7356b0](b7356b0))

### Continuous Integration

* **kitchen:** check for repos updates before trying package installation ([b632383](b632383))
* **kitchen:** improve comments about `opensuse` problems encountered ([c246939](c246939))
* **kitchen:** specify `image` explicitly for each platform ([b25fbdc](b25fbdc))
* **kitchen:** use `salt-minion` version of `opensuse` to ensure tests run ([99b073a](99b073a))
* **kitchen+travis:** disable `debian-8` due to `2019.2` installation bug ([178c710](178c710))
* **kitchen+travis:** use `debian:jessie-backports` as `debian-8` ([1b9d249](1b9d249)), closes [saltstack-formulas#50](https://github.com/myii/template-formula/issues/50) [/github.com/vmware-archive/salt-pack/issues/657#issuecomment-467932962](https://github.com//github.com/saltstack/salt-pack/issues/657/issues/issuecomment-467932962)
* **travis:** include `commitlint` stage ([6659a69](6659a69))
* **travis:** prevent `release` stage running for PRs ([3a072c7](3a072c7)), closes [/travis-ci.com/saltstack-formulas/template-formula/jobs/180068519#L466](https://github.com//travis-ci.com/saltstack-formulas/template-formula/jobs/180068519/issues/L466) [/github.com/saltstack-formulas/pull/42#issuecomment-466446324](https://github.com//github.com/saltstack-formulas/template-formula/pull/42/issues/issuecomment-466446324)
* **travis:** remove obsolete check based on `$TRAVIS_TEST_RESULT` ([6df9c95](6df9c95))

### Documentation

* **changelog:** add missing entry under `v0.3.2` ([50352b5](50352b5))
* **changelog:** merge previous `rst` into new `md` format ([2b4e485](2b4e485))
* **changelog:** remove erroneous "closes" used by `semantic-release` ([be4571d](be4571d))
* **components:** update for separation of `pkg`, `config` & `service` ([726fcab](726fcab))
* **contributing:** add basic introductory text before the TOC ([45ccaf6](45ccaf6))
* **contributing:** add commit message formatting instructions ([fb3d173](fb3d173))
* **contributing:** centre-align version bump columns in table ([a238cae](a238cae))
* **contributing:** create blank template ([3633e8f](3633e8f))
* **contributing:** modify quoted heading to prevent TOC inclusion ([abcb6ef](abcb6ef))
* **contributing:** separate `BREAKING CHANGE` under its own heading ([ee053d7](ee053d7))
* **contributing:** update with sub-headings and `commitlint` details ([ea2c9a4](ea2c9a4))
* **index:** use include for `README.rst` in `docs` and test RTD ([f073d36](f073d36))
* **readme:** add suggested improvement to `template.service.clean` ([bf1039c](bf1039c))
* **readme:** convert note into a heading ([5f2d789](5f2d789))
* **readme:** fix typos ([007159a](007159a))
* **rtd:** conduct further tests ([0e29290](0e29290))
* **tofs:** add more sub-headings to ease document navigation ([2c5dc21](2c5dc21))
* **tofs:** apply language formatting to source code blocks ([0638413](0638413))
* **tofs:** explain how all parts of the `source` can be customised ([2f82eb5](2f82eb5)), closes [saltstack-formulas#44](https://github.com/myii/template-formula/issues/44)
* **tofs:** improve general use of language ([5105d29](5105d29))
* **tofs:** update the `files_switch` section for the updated macro ([788f732](788f732))
* **tofs:** use `{%-` for all Jinja statements ([4348df8](4348df8))
* **yaml:** os*.yaml map files needs at least an empty dict ([dd99750](dd99750))

### Features

* **authors:** update automatically alongside `semantic-release` ([8000098](8000098))
* **kitchen+travis:** add `opensuse-leap` after resolving issues ([7614a3c](7614a3c))
* **kitchen+travis:** conduct tests on a wider range of platforms ([1348078](1348078))
* **pkg:** add `clean` states ([422c7ac](422c7ac))
* **pkg:** use `require` requisite between `pkg` states ([6e7141b](6e7141b)), closes [/github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/jinja.py#L120](https://github.com//github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/jinja.py/issues/L120) [/github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/templates.py#L145](https://github.com//github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/templates.py/issues/L145) [/github.com/saltstack/salt/issues/10838#issuecomment-391718086](https://github.com//github.com/saltstack/salt/issues/10838/issues/issuecomment-391718086)
* **semantic-release:** configure for this formula ([cbcfd75](cbcfd75))
* **toc:** use `markdown-toc` directly to update inline ([a5bae1e](a5bae1e))
* **tofs:** implement backwards-compatible TOFSv2 for configurability ([068a94d](068a94d)), closes [/freenode.logbot.info/saltstack-formulas/20190214#c1995273](https://github.com//freenode.logbot.info/saltstack-formulas/20190214/issues/c1995273) [/freenode.logbot.info/saltstack-formulas/20190214#c1995487](https://github.com//freenode.logbot.info/saltstack-formulas/20190214/issues/c1995487)

### Reverts

* **kitchen+travis:** disable `debian-8` due to `2019.2` bug ([e8f0f7e](e8f0f7e))

### Tests

* **inspec:** update `supports` for all platforms added ([42f93b3](42f93b3))

### BREAKING CHANGES

* **states:** Wholesale state ID changes will break implementations
that are relying on the previous state IDs for requisite purposes.
* **pkg:** Changing the `pkg` directory to `package` will break
implementations that are depending on `pkg` for `include` or `sls`-based
requisite purposes.
myii pushed a commit to myii/template-formula that referenced this pull request Feb 28, 2019
# [1.0.0](v0.2.0...v1.0.0) (2019-02-28)

### Bug Fixes

* **pillar:** fix `os_family` typo ([3f89c12](3f89c12))
* **tofs:** update comments in `files_switch` macro for new method ([3fa3640](3fa3640))
* **tofs:** use `tpldir` derivative `topdir` for pillar (config) paths ([5e9df00](5e9df00))

### Code Refactoring

* **components:** split components into separate subdirs ([d957055](d957055)), closes [/github.com/saltstack-formulas/pull/48#pullrequestreview-207182085](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/pullrequestreview-207182085) [/github.com/saltstack-formulas/pull/48#discussion_r259805312](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259805312)
* **include+require:** use variable for duplicate values ([4443518](4443518))
* **kitchen:** prefer `kitchen.yml` to `.kitchen.yml` ([3860bf9](3860bf9))
* **macros:** use `tplroot` instead of `topdir` to match `tpldata` ([923b459](923b459))
* **pkg:** change to `package` instead ([2cd82e5](2cd82e5)), closes [/github.com/saltstack-formulas/pull/48#discussion_r259951123](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259951123)
* **pkg:** move `pkg` related components into separate directory ([c21f82b](c21f82b))
* **states:** set state IDs based on a dependable structure ([6690ee6](6690ee6)), closes [/github.com/saltstack-formulas/pull/48#discussion_r259953473](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259953473) [/github.com/saltstack-formulas/pull/48#discussion_r259956996](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259956996)
* **topdir:** use for `include` and `require` except `init.sls` ([a218e91](a218e91))
* **tpldir:** use `topdir` globally in place of `tpldir` ([2838bc9](2838bc9))
* **tpldir:** use `tpldir` or derivatives to make formula portable ([52d03d8](52d03d8)), closes [saltstack-formulas#22](https://github.com/myii/template-formula/issues/22)
* **tplroot:** use `tplroot` instead of `topdir` to match `tpldata` ([b7356b0](b7356b0))

### Continuous Integration

* **kitchen:** check for repos updates before trying package installation ([b632383](b632383))
* **kitchen:** improve comments about `opensuse` problems encountered ([c246939](c246939))
* **kitchen:** specify `image` explicitly for each platform ([b25fbdc](b25fbdc))
* **kitchen:** use `salt-minion` version of `opensuse` to ensure tests run ([99b073a](99b073a))
* **kitchen+travis:** disable `debian-8` due to `2019.2` installation bug ([178c710](178c710))
* **kitchen+travis:** use `debian:jessie-backports` as `debian-8` ([1b9d249](1b9d249)), closes [saltstack-formulas#50](https://github.com/myii/template-formula/issues/50) [/github.com/vmware-archive/salt-pack/issues/657#issuecomment-467932962](https://github.com//github.com/saltstack/salt-pack/issues/657/issues/issuecomment-467932962)
* **travis:** include `commitlint` stage ([6659a69](6659a69))
* **travis:** prevent `release` stage running for PRs ([3a072c7](3a072c7)), closes [/travis-ci.com/saltstack-formulas/template-formula/jobs/180068519#L466](https://github.com//travis-ci.com/saltstack-formulas/template-formula/jobs/180068519/issues/L466) [/github.com/saltstack-formulas/pull/42#issuecomment-466446324](https://github.com//github.com/saltstack-formulas/template-formula/pull/42/issues/issuecomment-466446324)
* **travis:** remove obsolete check based on `$TRAVIS_TEST_RESULT` ([6df9c95](6df9c95))

### Documentation

* **changelog:** add missing entry under `v0.3.2` ([50352b5](50352b5))
* **changelog:** merge previous `rst` into new `md` format ([2b4e485](2b4e485))
* **changelog:** remove erroneous "closes" used by `semantic-release` ([be4571d](be4571d))
* **components:** update for separation of `pkg`, `config` & `service` ([726fcab](726fcab))
* **contributing:** add basic introductory text before the TOC ([45ccaf6](45ccaf6))
* **contributing:** add commit message formatting instructions ([fb3d173](fb3d173))
* **contributing:** centre-align version bump columns in table ([a238cae](a238cae))
* **contributing:** create blank template ([3633e8f](3633e8f))
* **contributing:** modify quoted heading to prevent TOC inclusion ([abcb6ef](abcb6ef))
* **contributing:** separate `BREAKING CHANGE` under its own heading ([ee053d7](ee053d7))
* **contributing:** update with sub-headings and `commitlint` details ([ea2c9a4](ea2c9a4))
* **index:** use include for `README.rst` in `docs` and test RTD ([f073d36](f073d36))
* **readme:** add suggested improvement to `template.service.clean` ([bf1039c](bf1039c))
* **readme:** convert note into a heading ([5f2d789](5f2d789))
* **readme:** fix typos ([007159a](007159a))
* **rtd:** conduct further tests ([c6520bf](c6520bf))
* **tofs:** add more sub-headings to ease document navigation ([2c5dc21](2c5dc21))
* **tofs:** apply language formatting to source code blocks ([0638413](0638413))
* **tofs:** explain how all parts of the `source` can be customised ([2f82eb5](2f82eb5)), closes [saltstack-formulas#44](https://github.com/myii/template-formula/issues/44)
* **tofs:** improve general use of language ([5105d29](5105d29))
* **tofs:** update the `files_switch` section for the updated macro ([788f732](788f732))
* **tofs:** use `{%-` for all Jinja statements ([4348df8](4348df8))
* **yaml:** os*.yaml map files needs at least an empty dict ([dd99750](dd99750))

### Features

* **authors:** update automatically alongside `semantic-release` ([8000098](8000098))
* **kitchen+travis:** add `opensuse-leap` after resolving issues ([7614a3c](7614a3c))
* **kitchen+travis:** conduct tests on a wider range of platforms ([1348078](1348078))
* **pkg:** add `clean` states ([422c7ac](422c7ac))
* **pkg:** use `require` requisite between `pkg` states ([6e7141b](6e7141b)), closes [/github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/jinja.py#L120](https://github.com//github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/jinja.py/issues/L120) [/github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/templates.py#L145](https://github.com//github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/templates.py/issues/L145) [/github.com/saltstack/salt/issues/10838#issuecomment-391718086](https://github.com//github.com/saltstack/salt/issues/10838/issues/issuecomment-391718086)
* **semantic-release:** configure for this formula ([cbcfd75](cbcfd75))
* **toc:** use `markdown-toc` directly to update inline ([a5bae1e](a5bae1e))
* **tofs:** implement backwards-compatible TOFSv2 for configurability ([068a94d](068a94d)), closes [/freenode.logbot.info/saltstack-formulas/20190214#c1995273](https://github.com//freenode.logbot.info/saltstack-formulas/20190214/issues/c1995273) [/freenode.logbot.info/saltstack-formulas/20190214#c1995487](https://github.com//freenode.logbot.info/saltstack-formulas/20190214/issues/c1995487)

### Reverts

* **kitchen+travis:** disable `debian-8` due to `2019.2` bug ([e8f0f7e](e8f0f7e))

### Tests

* **inspec:** update `supports` for all platforms added ([42f93b3](42f93b3))

### BREAKING CHANGES

* **states:** Wholesale state ID changes will break implementations
that are relying on the previous state IDs for requisite purposes.
* **pkg:** Changing the `pkg` directory to `package` will break
implementations that are depending on `pkg` for `include` or `sls`-based
requisite purposes.
myii pushed a commit to myii/template-formula that referenced this pull request Mar 1, 2019
# [1.0.0](v0.2.0...v1.0.0) (2019-03-01)

### Bug Fixes

* **pillar:** fix `os_family` typo ([3f89c12](3f89c12))
* **tofs:** update comments in `files_switch` macro for new method ([3fa3640](3fa3640))
* **tofs:** use `tpldir` derivative `topdir` for pillar (config) paths ([5e9df00](5e9df00))

### Code Refactoring

* **components:** split components into separate subdirs ([d957055](d957055)), closes [/github.com/saltstack-formulas/pull/48#pullrequestreview-207182085](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/pullrequestreview-207182085) [/github.com/saltstack-formulas/pull/48#discussion_r259805312](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259805312)
* **include+require:** use variable for duplicate values ([4443518](4443518))
* **kitchen:** prefer `kitchen.yml` to `.kitchen.yml` ([3860bf9](3860bf9))
* **macros:** use `tplroot` instead of `topdir` to match `tpldata` ([923b459](923b459))
* **pkg:** change to `package` instead ([2cd82e5](2cd82e5)), closes [/github.com/saltstack-formulas/pull/48#discussion_r259951123](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259951123)
* **pkg:** move `pkg` related components into separate directory ([c21f82b](c21f82b))
* **states:** set state IDs based on a dependable structure ([6690ee6](6690ee6)), closes [/github.com/saltstack-formulas/pull/48#discussion_r259953473](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259953473) [/github.com/saltstack-formulas/pull/48#discussion_r259956996](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259956996)
* **topdir:** use for `include` and `require` except `init.sls` ([a218e91](a218e91))
* **tpldir:** use `topdir` globally in place of `tpldir` ([2838bc9](2838bc9))
* **tpldir:** use `tpldir` or derivatives to make formula portable ([52d03d8](52d03d8)), closes [saltstack-formulas#22](https://github.com/myii/template-formula/issues/22)
* **tplroot:** use `tplroot` instead of `topdir` to match `tpldata` ([b7356b0](b7356b0))

### Continuous Integration

* **kitchen:** check for repos updates before trying package installation ([b632383](b632383))
* **kitchen:** improve comments about `opensuse` problems encountered ([c246939](c246939))
* **kitchen:** specify `image` explicitly for each platform ([b25fbdc](b25fbdc))
* **kitchen:** use `salt-minion` version of `opensuse` to ensure tests run ([99b073a](99b073a))
* **kitchen+travis:** disable `debian-8` due to `2019.2` installation bug ([178c710](178c710))
* **kitchen+travis:** use `debian:jessie-backports` as `debian-8` ([1b9d249](1b9d249)), closes [saltstack-formulas#50](https://github.com/myii/template-formula/issues/50) [/github.com/vmware-archive/salt-pack/issues/657#issuecomment-467932962](https://github.com//github.com/saltstack/salt-pack/issues/657/issues/issuecomment-467932962)
* **travis:** include `commitlint` stage ([6659a69](6659a69))
* **travis:** prevent `release` stage running for PRs ([3a072c7](3a072c7)), closes [/travis-ci.com/saltstack-formulas/template-formula/jobs/180068519#L466](https://github.com//travis-ci.com/saltstack-formulas/template-formula/jobs/180068519/issues/L466) [/github.com/saltstack-formulas/pull/42#issuecomment-466446324](https://github.com//github.com/saltstack-formulas/template-formula/pull/42/issues/issuecomment-466446324)
* **travis:** remove obsolete check based on `$TRAVIS_TEST_RESULT` ([6df9c95](6df9c95))
* **travis:** remove unavailable files from `markdown-toc` process ([3148f0d](3148f0d))

### Documentation

* **changelog:** add missing entry under `v0.3.2` ([50352b5](50352b5))
* **changelog:** merge previous `rst` into new `md` format ([2b4e485](2b4e485))
* **changelog:** remove erroneous "closes" used by `semantic-release` ([be4571d](be4571d))
* **components:** update for separation of `pkg`, `config` & `service` ([726fcab](726fcab))
* **contributing:** add basic introductory text before the TOC ([45ccaf6](45ccaf6))
* **contributing:** add commit message formatting instructions ([fb3d173](fb3d173))
* **contributing:** centre-align version bump columns in table ([a238cae](a238cae))
* **contributing:** convert to `.rst` and move to `docs` subdir ([474f318](474f318))
* **contributing:** create blank template ([3633e8f](3633e8f))
* **contributing:** format table for better layout ([25586ae](25586ae))
* **contributing:** modify quoted heading to prevent TOC inclusion ([abcb6ef](abcb6ef))
* **contributing:** separate `BREAKING CHANGE` under its own heading ([ee053d7](ee053d7))
* **contributing:** update with sub-headings and `commitlint` details ([ea2c9a4](ea2c9a4))
* **index:** add `CONTRIBUTING` to the `toctree` ([0c98e67](0c98e67))
* **readme:** add suggested improvement to `template.service.clean` ([bf1039c](bf1039c))
* **readme:** convert note into a heading ([5f2d789](5f2d789))
* **readme:** fix typos ([007159a](007159a))
* **readme:** move under `docs` subdir to access in both GitHub and RTD ([c92f674](c92f674))
* **readme:** update heading markers for consistency ([5a2bea8](5a2bea8))
* **rtd:** add basic `index.rst` to allow RTD to produce docs ([f02139f](f02139f))
* **rtd:** use `conf.py` to add custom `css` ([cb94e3b](cb94e3b))
* **rtd:** use internal link targets at the top of each `.rst` file ([da09528](da09528))
* **tofs:** add more sub-headings to ease document navigation ([2c5dc21](2c5dc21))
* **tofs:** apply language formatting to source code blocks ([0638413](0638413))
* **tofs:** explain how all parts of the `source` can be customised ([2f82eb5](2f82eb5)), closes [saltstack-formulas#44](https://github.com/myii/template-formula/issues/44)
* **tofs:** improve general use of language ([5105d29](5105d29))
* **tofs:** update the `files_switch` section for the updated macro ([788f732](788f732))
* **tofs:** use `{%-` for all Jinja statements ([4348df8](4348df8))
* **yaml:** os*.yaml map files needs at least an empty dict ([dd99750](dd99750))

### Features

* **authors:** update automatically alongside `semantic-release` ([8000098](8000098))
* **kitchen+travis:** add `opensuse-leap` after resolving issues ([7614a3c](7614a3c))
* **kitchen+travis:** conduct tests on a wider range of platforms ([1348078](1348078))
* **pkg:** add `clean` states ([422c7ac](422c7ac))
* **pkg:** use `require` requisite between `pkg` states ([6e7141b](6e7141b)), closes [/github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/jinja.py#L120](https://github.com//github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/jinja.py/issues/L120) [/github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/templates.py#L145](https://github.com//github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/templates.py/issues/L145) [/github.com/saltstack/salt/issues/10838#issuecomment-391718086](https://github.com//github.com/saltstack/salt/issues/10838/issues/issuecomment-391718086)
* **semantic-release:** configure for this formula ([cbcfd75](cbcfd75))
* **toc:** use `markdown-toc` directly to update inline ([a5bae1e](a5bae1e))
* **tofs:** implement backwards-compatible TOFSv2 for configurability ([068a94d](068a94d)), closes [/freenode.logbot.info/saltstack-formulas/20190214#c1995273](https://github.com//freenode.logbot.info/saltstack-formulas/20190214/issues/c1995273) [/freenode.logbot.info/saltstack-formulas/20190214#c1995487](https://github.com//freenode.logbot.info/saltstack-formulas/20190214/issues/c1995487)

### Reverts

* **kitchen+travis:** disable `debian-8` due to `2019.2` bug ([e8f0f7e](e8f0f7e))

### Tests

* **inspec:** update `supports` for all platforms added ([42f93b3](42f93b3))

### BREAKING CHANGES

* **states:** Wholesale state ID changes will break implementations
that are relying on the previous state IDs for requisite purposes.
* **pkg:** Changing the `pkg` directory to `package` will break
implementations that are depending on `pkg` for `include` or `sls`-based
requisite purposes.
myii pushed a commit to myii/template-formula that referenced this pull request Mar 1, 2019
# [1.0.0](v0.2.0...v1.0.0) (2019-03-01)

### Bug Fixes

* **pillar:** fix `os_family` typo ([3f89c12](3f89c12))
* **tofs:** update comments in `files_switch` macro for new method ([3fa3640](3fa3640))
* **tofs:** use `tpldir` derivative `topdir` for pillar (config) paths ([5e9df00](5e9df00))

### Code Refactoring

* **components:** split components into separate subdirs ([d957055](d957055)), closes [/github.com/saltstack-formulas/pull/48#pullrequestreview-207182085](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/pullrequestreview-207182085) [/github.com/saltstack-formulas/pull/48#discussion_r259805312](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259805312)
* **include+require:** use variable for duplicate values ([4443518](4443518))
* **kitchen:** prefer `kitchen.yml` to `.kitchen.yml` ([3860bf9](3860bf9))
* **macros:** use `tplroot` instead of `topdir` to match `tpldata` ([923b459](923b459))
* **pkg:** change to `package` instead ([2cd82e5](2cd82e5)), closes [/github.com/saltstack-formulas/pull/48#discussion_r259951123](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259951123)
* **pkg:** move `pkg` related components into separate directory ([c21f82b](c21f82b))
* **states:** set state IDs based on a dependable structure ([6690ee6](6690ee6)), closes [/github.com/saltstack-formulas/pull/48#discussion_r259953473](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259953473) [/github.com/saltstack-formulas/pull/48#discussion_r259956996](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259956996)
* **topdir:** use for `include` and `require` except `init.sls` ([a218e91](a218e91))
* **tpldir:** use `topdir` globally in place of `tpldir` ([2838bc9](2838bc9))
* **tpldir:** use `tpldir` or derivatives to make formula portable ([52d03d8](52d03d8)), closes [saltstack-formulas#22](https://github.com/myii/template-formula/issues/22)
* **tplroot:** use `tplroot` instead of `topdir` to match `tpldata` ([b7356b0](b7356b0))

### Continuous Integration

* **kitchen:** check for repos updates before trying package installation ([b632383](b632383))
* **kitchen:** improve comments about `opensuse` problems encountered ([c246939](c246939))
* **kitchen:** specify `image` explicitly for each platform ([b25fbdc](b25fbdc))
* **kitchen:** use `salt-minion` version of `opensuse` to ensure tests run ([99b073a](99b073a))
* **kitchen+travis:** disable `debian-8` due to `2019.2` installation bug ([178c710](178c710))
* **kitchen+travis:** use `debian:jessie-backports` as `debian-8` ([1b9d249](1b9d249)), closes [saltstack-formulas#50](https://github.com/myii/template-formula/issues/50) [/github.com/vmware-archive/salt-pack/issues/657#issuecomment-467932962](https://github.com//github.com/saltstack/salt-pack/issues/657/issues/issuecomment-467932962)
* **travis:** include `commitlint` stage ([6659a69](6659a69))
* **travis:** prevent `release` stage running for PRs ([3a072c7](3a072c7)), closes [/travis-ci.com/saltstack-formulas/template-formula/jobs/180068519#L466](https://github.com//travis-ci.com/saltstack-formulas/template-formula/jobs/180068519/issues/L466) [/github.com/saltstack-formulas/pull/42#issuecomment-466446324](https://github.com//github.com/saltstack-formulas/template-formula/pull/42/issues/issuecomment-466446324)
* **travis:** remove obsolete check based on `$TRAVIS_TEST_RESULT` ([6df9c95](6df9c95))
* **travis:** remove unavailable files from `markdown-toc` process ([3148f0d](3148f0d))

### Documentation

* **changelog:** add missing entry under `v0.3.2` ([50352b5](50352b5))
* **changelog:** merge previous `rst` into new `md` format ([2b4e485](2b4e485))
* **changelog:** remove erroneous "closes" used by `semantic-release` ([be4571d](be4571d))
* **components:** update for separation of `pkg`, `config` & `service` ([726fcab](726fcab))
* **contributing:** add basic introductory text before the TOC ([45ccaf6](45ccaf6))
* **contributing:** add commit message formatting instructions ([fb3d173](fb3d173))
* **contributing:** centre-align version bump columns in table ([a238cae](a238cae))
* **contributing:** convert to `.rst` and move to `docs` subdir ([474f318](474f318))
* **contributing:** create blank template ([3633e8f](3633e8f))
* **contributing:** format table for better layout ([25586ae](25586ae))
* **contributing:** modify quoted heading to prevent TOC inclusion ([abcb6ef](abcb6ef))
* **contributing:** separate `BREAKING CHANGE` under its own heading ([ee053d7](ee053d7))
* **contributing:** update with sub-headings and `commitlint` details ([ea2c9a4](ea2c9a4))
* **index:** add `CONTRIBUTING` to the `toctree` ([0c98e67](0c98e67))
* **readme:** add suggested improvement to `template.service.clean` ([bf1039c](bf1039c))
* **readme:** convert note into a heading ([5f2d789](5f2d789))
* **readme:** fix typos ([007159a](007159a))
* **readme:** move under `docs` subdir to access in both GitHub and RTD ([c92f674](c92f674))
* **readme:** update heading markers for consistency ([5a2bea8](5a2bea8))
* **rtd:** add basic `index.rst` to allow RTD to produce docs ([f02139f](f02139f))
* **rtd:** use `conf.py` to add custom `css` ([5b0ebe0](5b0ebe0))
* **rtd:** use internal link targets at the top of each `.rst` file ([da09528](da09528))
* **tofs:** add more sub-headings to ease document navigation ([2c5dc21](2c5dc21))
* **tofs:** apply language formatting to source code blocks ([0638413](0638413))
* **tofs:** explain how all parts of the `source` can be customised ([2f82eb5](2f82eb5)), closes [saltstack-formulas#44](https://github.com/myii/template-formula/issues/44)
* **tofs:** improve general use of language ([5105d29](5105d29))
* **tofs:** update the `files_switch` section for the updated macro ([788f732](788f732))
* **tofs:** use `{%-` for all Jinja statements ([4348df8](4348df8))
* **yaml:** os*.yaml map files needs at least an empty dict ([dd99750](dd99750))

### Features

* **authors:** update automatically alongside `semantic-release` ([8000098](8000098))
* **kitchen+travis:** add `opensuse-leap` after resolving issues ([7614a3c](7614a3c))
* **kitchen+travis:** conduct tests on a wider range of platforms ([1348078](1348078))
* **pkg:** add `clean` states ([422c7ac](422c7ac))
* **pkg:** use `require` requisite between `pkg` states ([6e7141b](6e7141b)), closes [/github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/jinja.py#L120](https://github.com//github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/jinja.py/issues/L120) [/github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/templates.py#L145](https://github.com//github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/templates.py/issues/L145) [/github.com/saltstack/salt/issues/10838#issuecomment-391718086](https://github.com//github.com/saltstack/salt/issues/10838/issues/issuecomment-391718086)
* **semantic-release:** configure for this formula ([cbcfd75](cbcfd75))
* **toc:** use `markdown-toc` directly to update inline ([a5bae1e](a5bae1e))
* **tofs:** implement backwards-compatible TOFSv2 for configurability ([068a94d](068a94d)), closes [/freenode.logbot.info/saltstack-formulas/20190214#c1995273](https://github.com//freenode.logbot.info/saltstack-formulas/20190214/issues/c1995273) [/freenode.logbot.info/saltstack-formulas/20190214#c1995487](https://github.com//freenode.logbot.info/saltstack-formulas/20190214/issues/c1995487)

### Reverts

* **kitchen+travis:** disable `debian-8` due to `2019.2` bug ([e8f0f7e](e8f0f7e))

### Tests

* **inspec:** update `supports` for all platforms added ([42f93b3](42f93b3))

### BREAKING CHANGES

* **states:** Wholesale state ID changes will break implementations
that are relying on the previous state IDs for requisite purposes.
* **pkg:** Changing the `pkg` directory to `package` will break
implementations that are depending on `pkg` for `include` or `sls`-based
requisite purposes.
myii pushed a commit to myii/template-formula that referenced this pull request Mar 3, 2019
# [1.0.0](v0.2.0...v1.0.0) (2019-03-03)

### Bug Fixes

* **pillar:** fix `os_family` typo ([3f89c12](3f89c12))
* **tofs:** update comments in `files_switch` macro for new method ([3fa3640](3fa3640))
* **tofs:** use `tpldir` derivative `topdir` for pillar (config) paths ([5e9df00](5e9df00))

### Code Refactoring

* **components:** split components into separate subdirs ([d957055](d957055)), closes [/github.com/saltstack-formulas/pull/48#pullrequestreview-207182085](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/pullrequestreview-207182085) [/github.com/saltstack-formulas/pull/48#discussion_r259805312](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259805312)
* **include+require:** use variable for duplicate values ([4443518](4443518))
* **kitchen:** prefer `kitchen.yml` to `.kitchen.yml` ([3860bf9](3860bf9))
* **macros:** use `tplroot` instead of `topdir` to match `tpldata` ([923b459](923b459))
* **pkg:** change to `package` instead ([2cd82e5](2cd82e5)), closes [/github.com/saltstack-formulas/pull/48#discussion_r259951123](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259951123)
* **pkg:** move `pkg` related components into separate directory ([c21f82b](c21f82b))
* **states:** set state IDs based on a dependable structure ([6690ee6](6690ee6)), closes [/github.com/saltstack-formulas/pull/48#discussion_r259953473](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259953473) [/github.com/saltstack-formulas/pull/48#discussion_r259956996](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259956996)
* **topdir:** use for `include` and `require` except `init.sls` ([a218e91](a218e91))
* **tpldir:** use `topdir` globally in place of `tpldir` ([2838bc9](2838bc9))
* **tpldir:** use `tpldir` or derivatives to make formula portable ([52d03d8](52d03d8)), closes [saltstack-formulas#22](https://github.com/myii/template-formula/issues/22)
* **tplroot:** use `tplroot` instead of `topdir` to match `tpldata` ([b7356b0](b7356b0))

### Continuous Integration

* **kitchen:** check for repos updates before trying package installation ([b632383](b632383))
* **kitchen:** improve comments about `opensuse` problems encountered ([c246939](c246939))
* **kitchen:** specify `image` explicitly for each platform ([b25fbdc](b25fbdc))
* **kitchen:** use `salt-minion` version of `opensuse` to ensure tests run ([99b073a](99b073a))
* **kitchen+travis:** disable `debian-8` due to `2019.2` installation bug ([178c710](178c710))
* **kitchen+travis:** use `debian:jessie-backports` as `debian-8` ([1b9d249](1b9d249)), closes [saltstack-formulas#50](https://github.com/myii/template-formula/issues/50) [/github.com/vmware-archive/salt-pack/issues/657#issuecomment-467932962](https://github.com//github.com/saltstack/salt-pack/issues/657/issues/issuecomment-467932962)
* **travis:** include `commitlint` stage ([6659a69](6659a69))
* **travis:** prevent `release` stage running for PRs ([3a072c7](3a072c7)), closes [/travis-ci.com/saltstack-formulas/template-formula/jobs/180068519#L466](https://github.com//travis-ci.com/saltstack-formulas/template-formula/jobs/180068519/issues/L466) [/github.com/saltstack-formulas/pull/42#issuecomment-466446324](https://github.com//github.com/saltstack-formulas/template-formula/pull/42/issues/issuecomment-466446324)
* **travis:** remove obsolete `markdown-toc` process ([97fbb60](97fbb60))
* **travis:** remove obsolete check based on `$TRAVIS_TEST_RESULT` ([6df9c95](6df9c95))
* **travis:** remove unavailable files from `markdown-toc` process ([3148f0d](3148f0d))

### Documentation

* **changelog:** add missing entry under `v0.3.2` ([50352b5](50352b5))
* **changelog:** merge previous `rst` into new `md` format ([2b4e485](2b4e485))
* **changelog:** remove erroneous "closes" used by `semantic-release` ([be4571d](be4571d))
* **components:** update for separation of `pkg`, `config` & `service` ([726fcab](726fcab))
* **contributing:** add basic introductory text before the TOC ([45ccaf6](45ccaf6))
* **contributing:** add commit message formatting instructions ([fb3d173](fb3d173))
* **contributing:** add documentation contribution guidelines ([dff0ee8](dff0ee8))
* **contributing:** add TOC to match all other pages ([7b1a2a9](7b1a2a9))
* **contributing:** centre-align version bump columns in table ([a238cae](a238cae))
* **contributing:** convert to `.rst` and move to `docs` subdir ([474f318](474f318))
* **contributing:** create blank template ([3633e8f](3633e8f))
* **contributing:** modify quoted heading to prevent TOC inclusion ([abcb6ef](abcb6ef))
* **contributing:** separate `BREAKING CHANGE` under its own heading ([ee053d7](ee053d7))
* **contributing:** update with sub-headings and `commitlint` details ([ea2c9a4](ea2c9a4))
* **index:** add `CONTRIBUTING` to the `toctree` ([0c98e67](0c98e67))
* **readme:** add Read the Docs build status badge ([f47797d](f47797d))
* **readme:** add suggested improvement to `template.service.clean` ([bf1039c](bf1039c))
* **readme:** convert note into a heading ([5f2d789](5f2d789))
* **readme:** fix typos ([007159a](007159a))
* **readme:** move under `docs` subdir to access in both GitHub and RTD ([c92f674](c92f674))
* **readme:** update heading markers for consistency ([5a2bea8](5a2bea8))
* **rtd:** add basic `docs/conf.py` to allow additional customisation ([18d3924](18d3924))
* **rtd:** add basic `index.rst` to allow RTD to produce docs ([f02139f](f02139f))
* **rtd:** add comment to CSS file for overriding in-use Sphinx theme ([f237364](f237364))
* **rtd:** clean up numerous issues and inconsistencies ([ad5a8b8](ad5a8b8))
* **rtd:** use internal link targets at the top of each `.rst` file ([da09528](da09528))
* **tofs:** add more sub-headings to ease document navigation ([2c5dc21](2c5dc21))
* **tofs:** apply language formatting to source code blocks ([0638413](0638413))
* **tofs:** explain how all parts of the `source` can be customised ([2f82eb5](2f82eb5)), closes [saltstack-formulas#44](https://github.com/myii/template-formula/issues/44)
* **tofs:** improve general use of language ([5105d29](5105d29))
* **tofs:** replace existing `.md` with `.rst` and add to RTD ([fd68168](fd68168))
* **tofs:** update the `files_switch` section for the updated macro ([788f732](788f732))
* **tofs:** use `{%-` for all Jinja statements ([4348df8](4348df8))
* **tofs:** use `literalinclude` of `macros.jinja` instead of code dupe ([3f0071b](3f0071b))
* **tofs:** use table to list authorship ([2f0e20f](2f0e20f))
* **yaml:** os*.yaml map files needs at least an empty dict ([dd99750](dd99750))

### Features

* **authors:** update automatically alongside `semantic-release` ([8000098](8000098))
* **kitchen+travis:** add `opensuse-leap` after resolving issues ([7614a3c](7614a3c))
* **kitchen+travis:** conduct tests on a wider range of platforms ([1348078](1348078))
* **pkg:** add `clean` states ([422c7ac](422c7ac))
* **pkg:** use `require` requisite between `pkg` states ([6e7141b](6e7141b)), closes [/github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/jinja.py#L120](https://github.com//github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/jinja.py/issues/L120) [/github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/templates.py#L145](https://github.com//github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/templates.py/issues/L145) [/github.com/saltstack/salt/issues/10838#issuecomment-391718086](https://github.com//github.com/saltstack/salt/issues/10838/issues/issuecomment-391718086)
* **rtd:** provide custom CSS file for overriding in-use Sphinx theme ([24bd338](24bd338))
* **semantic-release:** configure for this formula ([cbcfd75](cbcfd75))
* **toc:** use `markdown-toc` directly to update inline ([a5bae1e](a5bae1e))
* **tofs:** implement backwards-compatible TOFSv2 for configurability ([068a94d](068a94d)), closes [/freenode.logbot.info/saltstack-formulas/20190214#c1995273](https://github.com//freenode.logbot.info/saltstack-formulas/20190214/issues/c1995273) [/freenode.logbot.info/saltstack-formulas/20190214#c1995487](https://github.com//freenode.logbot.info/saltstack-formulas/20190214/issues/c1995487)

### Reverts

* **kitchen+travis:** disable `debian-8` due to `2019.2` bug ([e8f0f7e](e8f0f7e))

### Tests

* **inspec:** update `supports` for all platforms added ([42f93b3](42f93b3))

### BREAKING CHANGES

* **states:** Wholesale state ID changes will break implementations
that are relying on the previous state IDs for requisite purposes.
* **pkg:** Changing the `pkg` directory to `package` will break
implementations that are depending on `pkg` for `include` or `sls`-based
requisite purposes.
myii pushed a commit to myii/template-formula that referenced this pull request Mar 3, 2019
# [1.0.0](v0.2.0...v1.0.0) (2019-03-03)

### Bug Fixes

* **pillar:** fix `os_family` typo ([3f89c12](3f89c12))
* **tofs:** update comments in `files_switch` macro for new method ([3fa3640](3fa3640))
* **tofs:** use `tpldir` derivative `topdir` for pillar (config) paths ([5e9df00](5e9df00))

### Code Refactoring

* **components:** split components into separate subdirs ([d957055](d957055)), closes [/github.com/saltstack-formulas/pull/48#pullrequestreview-207182085](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/pullrequestreview-207182085) [/github.com/saltstack-formulas/pull/48#discussion_r259805312](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259805312)
* **include+require:** use variable for duplicate values ([4443518](4443518))
* **kitchen:** prefer `kitchen.yml` to `.kitchen.yml` ([3860bf9](3860bf9))
* **macros:** use `tplroot` instead of `topdir` to match `tpldata` ([923b459](923b459))
* **pkg:** change to `package` instead ([2cd82e5](2cd82e5)), closes [/github.com/saltstack-formulas/pull/48#discussion_r259951123](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259951123)
* **pkg:** move `pkg` related components into separate directory ([c21f82b](c21f82b))
* **states:** set state IDs based on a dependable structure ([6690ee6](6690ee6)), closes [/github.com/saltstack-formulas/pull/48#discussion_r259953473](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259953473) [/github.com/saltstack-formulas/pull/48#discussion_r259956996](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259956996)
* **topdir:** use for `include` and `require` except `init.sls` ([a218e91](a218e91))
* **tpldir:** use `topdir` globally in place of `tpldir` ([2838bc9](2838bc9))
* **tpldir:** use `tpldir` or derivatives to make formula portable ([52d03d8](52d03d8)), closes [saltstack-formulas#22](https://github.com/myii/template-formula/issues/22)
* **tplroot:** use `tplroot` instead of `topdir` to match `tpldata` ([b7356b0](b7356b0))

### Continuous Integration

* **kitchen:** check for repos updates before trying package installation ([b632383](b632383))
* **kitchen:** improve comments about `opensuse` problems encountered ([c246939](c246939))
* **kitchen:** specify `image` explicitly for each platform ([b25fbdc](b25fbdc))
* **kitchen:** use `salt-minion` version of `opensuse` to ensure tests run ([99b073a](99b073a))
* **kitchen+travis:** disable `debian-8` due to `2019.2` installation bug ([178c710](178c710))
* **kitchen+travis:** use `debian:jessie-backports` as `debian-8` ([1b9d249](1b9d249)), closes [saltstack-formulas#50](https://github.com/myii/template-formula/issues/50) [/github.com/vmware-archive/salt-pack/issues/657#issuecomment-467932962](https://github.com//github.com/saltstack/salt-pack/issues/657/issues/issuecomment-467932962)
* **travis:** include `commitlint` stage ([6659a69](6659a69))
* **travis:** prevent `release` stage running for PRs ([3a072c7](3a072c7)), closes [/travis-ci.com/saltstack-formulas/template-formula/jobs/180068519#L466](https://github.com//travis-ci.com/saltstack-formulas/template-formula/jobs/180068519/issues/L466) [/github.com/saltstack-formulas/pull/42#issuecomment-466446324](https://github.com//github.com/saltstack-formulas/template-formula/pull/42/issues/issuecomment-466446324)
* **travis:** remove obsolete `markdown-toc` process ([97fbb60](97fbb60))
* **travis:** remove obsolete check based on `$TRAVIS_TEST_RESULT` ([6df9c95](6df9c95))
* **travis:** remove unavailable files from `markdown-toc` process ([3148f0d](3148f0d))

### Documentation

* **changelog:** add missing entry under `v0.3.2` ([50352b5](50352b5))
* **changelog:** merge previous `rst` into new `md` format ([2b4e485](2b4e485))
* **changelog:** remove erroneous "closes" used by `semantic-release` ([be4571d](be4571d))
* **components:** update for separation of `pkg`, `config` & `service` ([726fcab](726fcab))
* **contributing:** add basic introductory text before the TOC ([45ccaf6](45ccaf6))
* **contributing:** add commit message formatting instructions ([fb3d173](fb3d173))
* **contributing:** add documentation contribution guidelines ([dff0ee8](dff0ee8))
* **contributing:** add TOC to match all other pages ([7b1a2a9](7b1a2a9))
* **contributing:** centre-align version bump columns in table ([a238cae](a238cae))
* **contributing:** convert to `.rst` and move to `docs` subdir ([474f318](474f318))
* **contributing:** create blank template ([3633e8f](3633e8f))
* **contributing:** modify quoted heading to prevent TOC inclusion ([abcb6ef](abcb6ef))
* **contributing:** separate `BREAKING CHANGE` under its own heading ([ee053d7](ee053d7))
* **contributing:** update with sub-headings and `commitlint` details ([ea2c9a4](ea2c9a4))
* **index:** add `CONTRIBUTING` to the `toctree` ([0c98e67](0c98e67))
* **readme:** add Read the Docs build status badge ([f47797d](f47797d))
* **readme:** add suggested improvement to `template.service.clean` ([bf1039c](bf1039c))
* **readme:** convert note into a heading ([5f2d789](5f2d789))
* **readme:** fix typos ([007159a](007159a))
* **readme:** move under `docs` subdir to access in both GitHub and RTD ([c92f674](c92f674))
* **readme:** update heading markers for consistency ([5a2bea8](5a2bea8))
* **rtd:** add basic `docs/conf.py` to allow additional customisation ([18d3924](18d3924))
* **rtd:** add basic `index.rst` to allow RTD to produce docs ([f02139f](f02139f))
* **rtd:** add comment to CSS file for overriding in-use Sphinx theme ([f237364](f237364))
* **rtd:** clean up numerous issues and inconsistencies ([ad5a8b8](ad5a8b8))
* **rtd:** use internal link targets at the top of each `.rst` file ([da09528](da09528))
* **tofs:** add more sub-headings to ease document navigation ([2c5dc21](2c5dc21))
* **tofs:** apply language formatting to source code blocks ([0638413](0638413))
* **tofs:** explain how all parts of the `source` can be customised ([2f82eb5](2f82eb5)), closes [saltstack-formulas#44](https://github.com/myii/template-formula/issues/44)
* **tofs:** improve general use of language ([5105d29](5105d29))
* **tofs:** replace existing `.md` with `.rst` and add to RTD ([fd68168](fd68168))
* **tofs:** update the `files_switch` section for the updated macro ([788f732](788f732))
* **tofs:** use `{%-` for all Jinja statements ([4348df8](4348df8))
* **tofs:** use `literalinclude` of `macros.jinja` instead of code dupe ([3f0071b](3f0071b))
* **tofs:** use table to list authorship ([2f0e20f](2f0e20f))
* **yaml:** os*.yaml map files needs at least an empty dict ([dd99750](dd99750))

### Features

* **authors:** update automatically alongside `semantic-release` ([8000098](8000098))
* **kitchen+travis:** add `opensuse-leap` after resolving issues ([7614a3c](7614a3c))
* **kitchen+travis:** conduct tests on a wider range of platforms ([1348078](1348078))
* **m2r:** use `m2r` to convert automatic `.md` files to `.rst` ([0b8b0c8](0b8b0c8))
* **pkg:** add `clean` states ([422c7ac](422c7ac))
* **pkg:** use `require` requisite between `pkg` states ([6e7141b](6e7141b)), closes [/github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/jinja.py#L120](https://github.com//github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/jinja.py/issues/L120) [/github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/templates.py#L145](https://github.com//github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/templates.py/issues/L145) [/github.com/saltstack/salt/issues/10838#issuecomment-391718086](https://github.com//github.com/saltstack/salt/issues/10838/issues/issuecomment-391718086)
* **rtd:** provide custom CSS file for overriding in-use Sphinx theme ([24bd338](24bd338))
* **semantic-release:** configure for this formula ([cbcfd75](cbcfd75))
* **toc:** use `markdown-toc` directly to update inline ([a5bae1e](a5bae1e))
* **tofs:** implement backwards-compatible TOFSv2 for configurability ([068a94d](068a94d)), closes [/freenode.logbot.info/saltstack-formulas/20190214#c1995273](https://github.com//freenode.logbot.info/saltstack-formulas/20190214/issues/c1995273) [/freenode.logbot.info/saltstack-formulas/20190214#c1995487](https://github.com//freenode.logbot.info/saltstack-formulas/20190214/issues/c1995487)

### Reverts

* **kitchen+travis:** disable `debian-8` due to `2019.2` bug ([e8f0f7e](e8f0f7e))

### Tests

* **inspec:** update `supports` for all platforms added ([42f93b3](42f93b3))

### BREAKING CHANGES

* **states:** Wholesale state ID changes will break implementations
that are relying on the previous state IDs for requisite purposes.
* **pkg:** Changing the `pkg` directory to `package` will break
implementations that are depending on `pkg` for `include` or `sls`-based
requisite purposes.
myii pushed a commit to myii/template-formula that referenced this pull request Mar 3, 2019
# [1.0.0](v0.2.0...v1.0.0) (2019-03-03)

### Bug Fixes

* **pillar:** fix `os_family` typo ([3f89c12](3f89c12))
* **tofs:** update comments in `files_switch` macro for new method ([3fa3640](3fa3640))
* **tofs:** use `tpldir` derivative `topdir` for pillar (config) paths ([5e9df00](5e9df00))

### Code Refactoring

* **components:** split components into separate subdirs ([d957055](d957055)), closes [/github.com/saltstack-formulas/pull/48#pullrequestreview-207182085](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/pullrequestreview-207182085) [/github.com/saltstack-formulas/pull/48#discussion_r259805312](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259805312)
* **include+require:** use variable for duplicate values ([4443518](4443518))
* **kitchen:** prefer `kitchen.yml` to `.kitchen.yml` ([3860bf9](3860bf9))
* **macros:** use `tplroot` instead of `topdir` to match `tpldata` ([923b459](923b459))
* **pkg:** change to `package` instead ([2cd82e5](2cd82e5)), closes [/github.com/saltstack-formulas/pull/48#discussion_r259951123](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259951123)
* **pkg:** move `pkg` related components into separate directory ([c21f82b](c21f82b))
* **states:** set state IDs based on a dependable structure ([6690ee6](6690ee6)), closes [/github.com/saltstack-formulas/pull/48#discussion_r259953473](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259953473) [/github.com/saltstack-formulas/pull/48#discussion_r259956996](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259956996)
* **topdir:** use for `include` and `require` except `init.sls` ([a218e91](a218e91))
* **tpldir:** use `topdir` globally in place of `tpldir` ([2838bc9](2838bc9))
* **tpldir:** use `tpldir` or derivatives to make formula portable ([52d03d8](52d03d8)), closes [saltstack-formulas#22](https://github.com/myii/template-formula/issues/22)
* **tplroot:** use `tplroot` instead of `topdir` to match `tpldata` ([b7356b0](b7356b0))

### Continuous Integration

* **kitchen:** check for repos updates before trying package installation ([b632383](b632383))
* **kitchen:** improve comments about `opensuse` problems encountered ([c246939](c246939))
* **kitchen:** specify `image` explicitly for each platform ([b25fbdc](b25fbdc))
* **kitchen:** use `salt-minion` version of `opensuse` to ensure tests run ([99b073a](99b073a))
* **kitchen+travis:** disable `debian-8` due to `2019.2` installation bug ([178c710](178c710))
* **kitchen+travis:** use `debian:jessie-backports` as `debian-8` ([1b9d249](1b9d249)), closes [saltstack-formulas#50](https://github.com/myii/template-formula/issues/50) [/github.com/vmware-archive/salt-pack/issues/657#issuecomment-467932962](https://github.com//github.com/saltstack/salt-pack/issues/657/issues/issuecomment-467932962)
* **travis:** include `commitlint` stage ([6659a69](6659a69))
* **travis:** prevent `release` stage running for PRs ([3a072c7](3a072c7)), closes [/travis-ci.com/saltstack-formulas/template-formula/jobs/180068519#L466](https://github.com//travis-ci.com/saltstack-formulas/template-formula/jobs/180068519/issues/L466) [/github.com/saltstack-formulas/pull/42#issuecomment-466446324](https://github.com//github.com/saltstack-formulas/template-formula/pull/42/issues/issuecomment-466446324)
* **travis:** remove obsolete `markdown-toc` process ([97fbb60](97fbb60))
* **travis:** remove obsolete check based on `$TRAVIS_TEST_RESULT` ([6df9c95](6df9c95))
* **travis:** remove unavailable files from `markdown-toc` process ([3148f0d](3148f0d))

### Documentation

* **changelog:** add missing entry under `v0.3.2` ([50352b5](50352b5))
* **changelog:** merge previous `rst` into new `md` format ([2b4e485](2b4e485))
* **changelog:** remove erroneous "closes" used by `semantic-release` ([be4571d](be4571d))
* **components:** update for separation of `pkg`, `config` & `service` ([726fcab](726fcab))
* **contributing:** add basic introductory text before the TOC ([45ccaf6](45ccaf6))
* **contributing:** add commit message formatting instructions ([fb3d173](fb3d173))
* **contributing:** add documentation contribution guidelines ([dff0ee8](dff0ee8))
* **contributing:** add TOC to match all other pages ([7b1a2a9](7b1a2a9))
* **contributing:** centre-align version bump columns in table ([a238cae](a238cae))
* **contributing:** convert to `.rst` and move to `docs` subdir ([474f318](474f318))
* **contributing:** create blank template ([3633e8f](3633e8f))
* **contributing:** modify quoted heading to prevent TOC inclusion ([abcb6ef](abcb6ef))
* **contributing:** separate `BREAKING CHANGE` under its own heading ([ee053d7](ee053d7))
* **contributing:** update with sub-headings and `commitlint` details ([ea2c9a4](ea2c9a4))
* **index:** add `CONTRIBUTING` to the `toctree` ([0c98e67](0c98e67))
* **readme:** add Read the Docs build status badge ([f47797d](f47797d))
* **readme:** add suggested improvement to `template.service.clean` ([bf1039c](bf1039c))
* **readme:** convert note into a heading ([5f2d789](5f2d789))
* **readme:** fix typos ([007159a](007159a))
* **readme:** move under `docs` subdir to access in both GitHub and RTD ([c92f674](c92f674))
* **readme:** update heading markers for consistency ([5a2bea8](5a2bea8))
* **rtd:** add basic `docs/conf.py` to allow additional customisation ([18d3924](18d3924))
* **rtd:** add basic `index.rst` to allow RTD to produce docs ([f02139f](f02139f))
* **rtd:** add comment to CSS file for overriding in-use Sphinx theme ([f237364](f237364))
* **rtd:** clean up numerous issues and inconsistencies ([ad5a8b8](ad5a8b8))
* **rtd:** use internal link targets at the top of each `.rst` file ([da09528](da09528))
* **tofs:** add more sub-headings to ease document navigation ([2c5dc21](2c5dc21))
* **tofs:** apply language formatting to source code blocks ([0638413](0638413))
* **tofs:** explain how all parts of the `source` can be customised ([2f82eb5](2f82eb5)), closes [saltstack-formulas#44](https://github.com/myii/template-formula/issues/44)
* **tofs:** improve general use of language ([5105d29](5105d29))
* **tofs:** replace existing `.md` with `.rst` and add to RTD ([fd68168](fd68168))
* **tofs:** update the `files_switch` section for the updated macro ([788f732](788f732))
* **tofs:** use `{%-` for all Jinja statements ([4348df8](4348df8))
* **tofs:** use `literalinclude` of `macros.jinja` instead of code dupe ([3f0071b](3f0071b))
* **tofs:** use table to list authorship ([2f0e20f](2f0e20f))
* **yaml:** os*.yaml map files needs at least an empty dict ([dd99750](dd99750))

### Features

* **authors:** update automatically alongside `semantic-release` ([8000098](8000098))
* **kitchen+travis:** add `opensuse-leap` after resolving issues ([7614a3c](7614a3c))
* **kitchen+travis:** conduct tests on a wider range of platforms ([1348078](1348078))
* **m2r:** use `m2r` to convert automatic `.md` files to `.rst` ([04db4e4](04db4e4))
* **pkg:** add `clean` states ([422c7ac](422c7ac))
* **pkg:** use `require` requisite between `pkg` states ([6e7141b](6e7141b)), closes [/github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/jinja.py#L120](https://github.com//github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/jinja.py/issues/L120) [/github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/templates.py#L145](https://github.com//github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/templates.py/issues/L145) [/github.com/saltstack/salt/issues/10838#issuecomment-391718086](https://github.com//github.com/saltstack/salt/issues/10838/issues/issuecomment-391718086)
* **rtd:** provide custom CSS file for overriding in-use Sphinx theme ([24bd338](24bd338))
* **semantic-release:** configure for this formula ([cbcfd75](cbcfd75))
* **toc:** use `markdown-toc` directly to update inline ([a5bae1e](a5bae1e))
* **tofs:** implement backwards-compatible TOFSv2 for configurability ([068a94d](068a94d)), closes [/freenode.logbot.info/saltstack-formulas/20190214#c1995273](https://github.com//freenode.logbot.info/saltstack-formulas/20190214/issues/c1995273) [/freenode.logbot.info/saltstack-formulas/20190214#c1995487](https://github.com//freenode.logbot.info/saltstack-formulas/20190214/issues/c1995487)

### Reverts

* **kitchen+travis:** disable `debian-8` due to `2019.2` bug ([e8f0f7e](e8f0f7e))

### Tests

* **inspec:** update `supports` for all platforms added ([42f93b3](42f93b3))

### BREAKING CHANGES

* **states:** Wholesale state ID changes will break implementations
that are relying on the previous state IDs for requisite purposes.
* **pkg:** Changing the `pkg` directory to `package` will break
implementations that are depending on `pkg` for `include` or `sls`-based
requisite purposes.
myii pushed a commit to myii/template-formula that referenced this pull request Mar 3, 2019
# [1.0.0](v0.2.0...v1.0.0) (2019-03-03)

### Bug Fixes

* **pillar:** fix `os_family` typo ([3f89c12](3f89c12))
* **tofs:** update comments in `files_switch` macro for new method ([3fa3640](3fa3640))
* **tofs:** use `tpldir` derivative `topdir` for pillar (config) paths ([5e9df00](5e9df00))

### Code Refactoring

* **components:** split components into separate subdirs ([d957055](d957055)), closes [/github.com/saltstack-formulas/pull/48#pullrequestreview-207182085](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/pullrequestreview-207182085) [/github.com/saltstack-formulas/pull/48#discussion_r259805312](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259805312)
* **include+require:** use variable for duplicate values ([4443518](4443518))
* **kitchen:** prefer `kitchen.yml` to `.kitchen.yml` ([3860bf9](3860bf9))
* **macros:** use `tplroot` instead of `topdir` to match `tpldata` ([923b459](923b459))
* **pkg:** change to `package` instead ([2cd82e5](2cd82e5)), closes [/github.com/saltstack-formulas/pull/48#discussion_r259951123](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259951123)
* **pkg:** move `pkg` related components into separate directory ([c21f82b](c21f82b))
* **states:** set state IDs based on a dependable structure ([6690ee6](6690ee6)), closes [/github.com/saltstack-formulas/pull/48#discussion_r259953473](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259953473) [/github.com/saltstack-formulas/pull/48#discussion_r259956996](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259956996)
* **topdir:** use for `include` and `require` except `init.sls` ([a218e91](a218e91))
* **tpldir:** use `topdir` globally in place of `tpldir` ([2838bc9](2838bc9))
* **tpldir:** use `tpldir` or derivatives to make formula portable ([52d03d8](52d03d8)), closes [saltstack-formulas#22](https://github.com/myii/template-formula/issues/22)
* **tplroot:** use `tplroot` instead of `topdir` to match `tpldata` ([b7356b0](b7356b0))

### Continuous Integration

* **kitchen:** check for repos updates before trying package installation ([b632383](b632383))
* **kitchen:** improve comments about `opensuse` problems encountered ([c246939](c246939))
* **kitchen:** specify `image` explicitly for each platform ([b25fbdc](b25fbdc))
* **kitchen:** use `salt-minion` version of `opensuse` to ensure tests run ([99b073a](99b073a))
* **kitchen+travis:** disable `debian-8` due to `2019.2` installation bug ([178c710](178c710))
* **kitchen+travis:** use `debian:jessie-backports` as `debian-8` ([1b9d249](1b9d249)), closes [saltstack-formulas#50](https://github.com/myii/template-formula/issues/50) [/github.com/vmware-archive/salt-pack/issues/657#issuecomment-467932962](https://github.com//github.com/saltstack/salt-pack/issues/657/issues/issuecomment-467932962)
* **travis:** include `commitlint` stage ([6659a69](6659a69))
* **travis:** prevent `release` stage running for PRs ([3a072c7](3a072c7)), closes [/travis-ci.com/saltstack-formulas/template-formula/jobs/180068519#L466](https://github.com//travis-ci.com/saltstack-formulas/template-formula/jobs/180068519/issues/L466) [/github.com/saltstack-formulas/pull/42#issuecomment-466446324](https://github.com//github.com/saltstack-formulas/template-formula/pull/42/issues/issuecomment-466446324)
* **travis:** remove obsolete `markdown-toc` process ([97fbb60](97fbb60))
* **travis:** remove obsolete check based on `$TRAVIS_TEST_RESULT` ([6df9c95](6df9c95))
* **travis:** remove unavailable files from `markdown-toc` process ([3148f0d](3148f0d))

### Documentation

* **changelog:** add missing entry under `v0.3.2` ([50352b5](50352b5))
* **changelog:** merge previous `rst` into new `md` format ([2b4e485](2b4e485))
* **changelog:** remove erroneous "closes" used by `semantic-release` ([be4571d](be4571d))
* **components:** update for separation of `pkg`, `config` & `service` ([726fcab](726fcab))
* **contributing:** add basic introductory text before the TOC ([45ccaf6](45ccaf6))
* **contributing:** add commit message formatting instructions ([fb3d173](fb3d173))
* **contributing:** add documentation contribution guidelines ([dff0ee8](dff0ee8))
* **contributing:** add TOC to match all other pages ([7b1a2a9](7b1a2a9))
* **contributing:** centre-align version bump columns in table ([a238cae](a238cae))
* **contributing:** convert to `.rst` and move to `docs` subdir ([474f318](474f318))
* **contributing:** create blank template ([3633e8f](3633e8f))
* **contributing:** modify quoted heading to prevent TOC inclusion ([abcb6ef](abcb6ef))
* **contributing:** separate `BREAKING CHANGE` under its own heading ([ee053d7](ee053d7))
* **contributing:** update with sub-headings and `commitlint` details ([ea2c9a4](ea2c9a4))
* **index:** add `CONTRIBUTING` to the `toctree` ([0c98e67](0c98e67))
* **readme:** add Read the Docs build status badge ([f47797d](f47797d))
* **readme:** add suggested improvement to `template.service.clean` ([bf1039c](bf1039c))
* **readme:** convert note into a heading ([5f2d789](5f2d789))
* **readme:** fix typos ([007159a](007159a))
* **readme:** move under `docs` subdir to access in both GitHub and RTD ([c92f674](c92f674))
* **readme:** update heading markers for consistency ([5a2bea8](5a2bea8))
* **rtd:** add basic `docs/conf.py` to allow additional customisation ([18d3924](18d3924))
* **rtd:** add basic `index.rst` to allow RTD to produce docs ([f02139f](f02139f))
* **rtd:** add comment to CSS file for overriding in-use Sphinx theme ([f237364](f237364))
* **rtd:** clean up numerous issues and inconsistencies ([ad5a8b8](ad5a8b8))
* **rtd:** use internal link targets at the top of each `.rst` file ([da09528](da09528))
* **tofs:** add more sub-headings to ease document navigation ([2c5dc21](2c5dc21))
* **tofs:** apply language formatting to source code blocks ([0638413](0638413))
* **tofs:** explain how all parts of the `source` can be customised ([2f82eb5](2f82eb5)), closes [saltstack-formulas#44](https://github.com/myii/template-formula/issues/44)
* **tofs:** improve general use of language ([5105d29](5105d29))
* **tofs:** replace existing `.md` with `.rst` and add to RTD ([fd68168](fd68168))
* **tofs:** update the `files_switch` section for the updated macro ([788f732](788f732))
* **tofs:** use `{%-` for all Jinja statements ([4348df8](4348df8))
* **tofs:** use `literalinclude` of `macros.jinja` instead of code dupe ([3f0071b](3f0071b))
* **tofs:** use table to list authorship ([2f0e20f](2f0e20f))
* **yaml:** os*.yaml map files needs at least an empty dict ([dd99750](dd99750))

### Features

* **authors:** update automatically alongside `semantic-release` ([8000098](8000098))
* **kitchen+travis:** add `opensuse-leap` after resolving issues ([7614a3c](7614a3c))
* **kitchen+travis:** conduct tests on a wider range of platforms ([1348078](1348078))
* **m2r:** use `m2r` to convert automatic `.md` files to `.rst` ([0a8afd3](0a8afd3))
* **pkg:** add `clean` states ([422c7ac](422c7ac))
* **pkg:** use `require` requisite between `pkg` states ([6e7141b](6e7141b)), closes [/github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/jinja.py#L120](https://github.com//github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/jinja.py/issues/L120) [/github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/templates.py#L145](https://github.com//github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/templates.py/issues/L145) [/github.com/saltstack/salt/issues/10838#issuecomment-391718086](https://github.com//github.com/saltstack/salt/issues/10838/issues/issuecomment-391718086)
* **rtd:** provide custom CSS file for overriding in-use Sphinx theme ([24bd338](24bd338))
* **semantic-release:** configure for this formula ([cbcfd75](cbcfd75))
* **toc:** use `markdown-toc` directly to update inline ([a5bae1e](a5bae1e))
* **tofs:** implement backwards-compatible TOFSv2 for configurability ([068a94d](068a94d)), closes [/freenode.logbot.info/saltstack-formulas/20190214#c1995273](https://github.com//freenode.logbot.info/saltstack-formulas/20190214/issues/c1995273) [/freenode.logbot.info/saltstack-formulas/20190214#c1995487](https://github.com//freenode.logbot.info/saltstack-formulas/20190214/issues/c1995487)

### Reverts

* **kitchen+travis:** disable `debian-8` due to `2019.2` bug ([e8f0f7e](e8f0f7e))

### Tests

* **inspec:** update `supports` for all platforms added ([42f93b3](42f93b3))

### BREAKING CHANGES

* **states:** Wholesale state ID changes will break implementations
that are relying on the previous state IDs for requisite purposes.
* **pkg:** Changing the `pkg` directory to `package` will break
implementations that are depending on `pkg` for `include` or `sls`-based
requisite purposes.
myii pushed a commit to myii/template-formula that referenced this pull request Mar 3, 2019
# [1.0.0](v0.2.0...v1.0.0) (2019-03-03)

### Bug Fixes

* **pillar:** fix `os_family` typo ([3f89c12](3f89c12))
* **tofs:** update comments in `files_switch` macro for new method ([3fa3640](3fa3640))
* **tofs:** use `tpldir` derivative `topdir` for pillar (config) paths ([5e9df00](5e9df00))

### Code Refactoring

* **components:** split components into separate subdirs ([d957055](d957055)), closes [/github.com/saltstack-formulas/pull/48#pullrequestreview-207182085](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/pullrequestreview-207182085) [/github.com/saltstack-formulas/pull/48#discussion_r259805312](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259805312)
* **include+require:** use variable for duplicate values ([4443518](4443518))
* **kitchen:** prefer `kitchen.yml` to `.kitchen.yml` ([3860bf9](3860bf9))
* **macros:** use `tplroot` instead of `topdir` to match `tpldata` ([923b459](923b459))
* **pkg:** change to `package` instead ([2cd82e5](2cd82e5)), closes [/github.com/saltstack-formulas/pull/48#discussion_r259951123](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259951123)
* **pkg:** move `pkg` related components into separate directory ([c21f82b](c21f82b))
* **states:** set state IDs based on a dependable structure ([6690ee6](6690ee6)), closes [/github.com/saltstack-formulas/pull/48#discussion_r259953473](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259953473) [/github.com/saltstack-formulas/pull/48#discussion_r259956996](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259956996)
* **topdir:** use for `include` and `require` except `init.sls` ([a218e91](a218e91))
* **tpldir:** use `topdir` globally in place of `tpldir` ([2838bc9](2838bc9))
* **tpldir:** use `tpldir` or derivatives to make formula portable ([52d03d8](52d03d8)), closes [saltstack-formulas#22](https://github.com/myii/template-formula/issues/22)
* **tplroot:** use `tplroot` instead of `topdir` to match `tpldata` ([b7356b0](b7356b0))

### Continuous Integration

* **kitchen:** check for repos updates before trying package installation ([b632383](b632383))
* **kitchen:** improve comments about `opensuse` problems encountered ([c246939](c246939))
* **kitchen:** specify `image` explicitly for each platform ([b25fbdc](b25fbdc))
* **kitchen:** use `salt-minion` version of `opensuse` to ensure tests run ([99b073a](99b073a))
* **kitchen+travis:** disable `debian-8` due to `2019.2` installation bug ([178c710](178c710))
* **kitchen+travis:** use `debian:jessie-backports` as `debian-8` ([1b9d249](1b9d249)), closes [saltstack-formulas#50](https://github.com/myii/template-formula/issues/50) [/github.com/vmware-archive/salt-pack/issues/657#issuecomment-467932962](https://github.com//github.com/saltstack/salt-pack/issues/657/issues/issuecomment-467932962)
* **travis:** include `commitlint` stage ([6659a69](6659a69))
* **travis:** prevent `release` stage running for PRs ([3a072c7](3a072c7)), closes [/travis-ci.com/saltstack-formulas/template-formula/jobs/180068519#L466](https://github.com//travis-ci.com/saltstack-formulas/template-formula/jobs/180068519/issues/L466) [/github.com/saltstack-formulas/pull/42#issuecomment-466446324](https://github.com//github.com/saltstack-formulas/template-formula/pull/42/issues/issuecomment-466446324)
* **travis:** remove obsolete `markdown-toc` process ([97fbb60](97fbb60))
* **travis:** remove obsolete check based on `$TRAVIS_TEST_RESULT` ([6df9c95](6df9c95))
* **travis:** remove unavailable files from `markdown-toc` process ([3148f0d](3148f0d))

### Documentation

* **changelog:** add missing entry under `v0.3.2` ([50352b5](50352b5))
* **changelog:** merge previous `rst` into new `md` format ([2b4e485](2b4e485))
* **changelog:** remove erroneous "closes" used by `semantic-release` ([be4571d](be4571d))
* **components:** update for separation of `pkg`, `config` & `service` ([726fcab](726fcab))
* **contributing:** add basic introductory text before the TOC ([45ccaf6](45ccaf6))
* **contributing:** add commit message formatting instructions ([fb3d173](fb3d173))
* **contributing:** add documentation contribution guidelines ([dff0ee8](dff0ee8))
* **contributing:** add TOC to match all other pages ([7b1a2a9](7b1a2a9))
* **contributing:** centre-align version bump columns in table ([a238cae](a238cae))
* **contributing:** convert to `.rst` and move to `docs` subdir ([474f318](474f318))
* **contributing:** create blank template ([3633e8f](3633e8f))
* **contributing:** modify quoted heading to prevent TOC inclusion ([abcb6ef](abcb6ef))
* **contributing:** separate `BREAKING CHANGE` under its own heading ([ee053d7](ee053d7))
* **contributing:** update with sub-headings and `commitlint` details ([ea2c9a4](ea2c9a4))
* **index:** add `CONTRIBUTING` to the `toctree` ([0c98e67](0c98e67))
* **readme:** add Read the Docs build status badge ([f47797d](f47797d))
* **readme:** add suggested improvement to `template.service.clean` ([bf1039c](bf1039c))
* **readme:** convert note into a heading ([5f2d789](5f2d789))
* **readme:** fix typos ([007159a](007159a))
* **readme:** move under `docs` subdir to access in both GitHub and RTD ([c92f674](c92f674))
* **readme:** update heading markers for consistency ([5a2bea8](5a2bea8))
* **rtd:** add basic `docs/conf.py` to allow additional customisation ([18d3924](18d3924))
* **rtd:** add basic `index.rst` to allow RTD to produce docs ([f02139f](f02139f))
* **rtd:** add comment to CSS file for overriding in-use Sphinx theme ([f237364](f237364))
* **rtd:** clean up numerous issues and inconsistencies ([ad5a8b8](ad5a8b8))
* **rtd:** use internal link targets at the top of each `.rst` file ([da09528](da09528))
* **tofs:** add more sub-headings to ease document navigation ([2c5dc21](2c5dc21))
* **tofs:** apply language formatting to source code blocks ([0638413](0638413))
* **tofs:** explain how all parts of the `source` can be customised ([2f82eb5](2f82eb5)), closes [saltstack-formulas#44](https://github.com/myii/template-formula/issues/44)
* **tofs:** improve general use of language ([5105d29](5105d29))
* **tofs:** replace existing `.md` with `.rst` and add to RTD ([fd68168](fd68168))
* **tofs:** update the `files_switch` section for the updated macro ([788f732](788f732))
* **tofs:** use `{%-` for all Jinja statements ([4348df8](4348df8))
* **tofs:** use `literalinclude` of `macros.jinja` instead of code dupe ([3f0071b](3f0071b))
* **tofs:** use table to list authorship ([2f0e20f](2f0e20f))
* **yaml:** os*.yaml map files needs at least an empty dict ([dd99750](dd99750))

### Features

* **authors:** update automatically alongside `semantic-release` ([8000098](8000098))
* **kitchen+travis:** add `opensuse-leap` after resolving issues ([7614a3c](7614a3c))
* **kitchen+travis:** conduct tests on a wider range of platforms ([1348078](1348078))
* **m2r:** use `m2r` to convert automatic `.md` files to `.rst` ([f6edb65](f6edb65))
* **pkg:** add `clean` states ([422c7ac](422c7ac))
* **pkg:** use `require` requisite between `pkg` states ([6e7141b](6e7141b)), closes [/github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/jinja.py#L120](https://github.com//github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/jinja.py/issues/L120) [/github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/templates.py#L145](https://github.com//github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/templates.py/issues/L145) [/github.com/saltstack/salt/issues/10838#issuecomment-391718086](https://github.com//github.com/saltstack/salt/issues/10838/issues/issuecomment-391718086)
* **rtd:** provide custom CSS file for overriding in-use Sphinx theme ([24bd338](24bd338))
* **semantic-release:** configure for this formula ([cbcfd75](cbcfd75))
* **toc:** use `markdown-toc` directly to update inline ([a5bae1e](a5bae1e))
* **tofs:** implement backwards-compatible TOFSv2 for configurability ([068a94d](068a94d)), closes [/freenode.logbot.info/saltstack-formulas/20190214#c1995273](https://github.com//freenode.logbot.info/saltstack-formulas/20190214/issues/c1995273) [/freenode.logbot.info/saltstack-formulas/20190214#c1995487](https://github.com//freenode.logbot.info/saltstack-formulas/20190214/issues/c1995487)

### Reverts

* **kitchen+travis:** disable `debian-8` due to `2019.2` bug ([e8f0f7e](e8f0f7e))

### Tests

* **inspec:** update `supports` for all platforms added ([42f93b3](42f93b3))

### BREAKING CHANGES

* **states:** Wholesale state ID changes will break implementations
that are relying on the previous state IDs for requisite purposes.
* **pkg:** Changing the `pkg` directory to `package` will break
implementations that are depending on `pkg` for `include` or `sls`-based
requisite purposes.
myii pushed a commit to myii/template-formula that referenced this pull request Mar 3, 2019
# [1.0.0](v0.2.0...v1.0.0) (2019-03-03)

### Bug Fixes

* **pillar:** fix `os_family` typo ([3f89c12](3f89c12))
* **tofs:** update comments in `files_switch` macro for new method ([3fa3640](3fa3640))
* **tofs:** use `tpldir` derivative `topdir` for pillar (config) paths ([5e9df00](5e9df00))

### Code Refactoring

* **components:** split components into separate subdirs ([d957055](d957055)), closes [/github.com/saltstack-formulas/pull/48#pullrequestreview-207182085](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/pullrequestreview-207182085) [/github.com/saltstack-formulas/pull/48#discussion_r259805312](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259805312)
* **include+require:** use variable for duplicate values ([4443518](4443518))
* **kitchen:** prefer `kitchen.yml` to `.kitchen.yml` ([3860bf9](3860bf9))
* **macros:** use `tplroot` instead of `topdir` to match `tpldata` ([923b459](923b459))
* **pkg:** change to `package` instead ([2cd82e5](2cd82e5)), closes [/github.com/saltstack-formulas/pull/48#discussion_r259951123](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259951123)
* **pkg:** move `pkg` related components into separate directory ([c21f82b](c21f82b))
* **states:** set state IDs based on a dependable structure ([6690ee6](6690ee6)), closes [/github.com/saltstack-formulas/pull/48#discussion_r259953473](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259953473) [/github.com/saltstack-formulas/pull/48#discussion_r259956996](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259956996)
* **topdir:** use for `include` and `require` except `init.sls` ([a218e91](a218e91))
* **tpldir:** use `topdir` globally in place of `tpldir` ([2838bc9](2838bc9))
* **tpldir:** use `tpldir` or derivatives to make formula portable ([52d03d8](52d03d8)), closes [saltstack-formulas#22](https://github.com/myii/template-formula/issues/22)
* **tplroot:** use `tplroot` instead of `topdir` to match `tpldata` ([b7356b0](b7356b0))

### Continuous Integration

* **kitchen:** check for repos updates before trying package installation ([b632383](b632383))
* **kitchen:** improve comments about `opensuse` problems encountered ([c246939](c246939))
* **kitchen:** specify `image` explicitly for each platform ([b25fbdc](b25fbdc))
* **kitchen:** use `salt-minion` version of `opensuse` to ensure tests run ([99b073a](99b073a))
* **kitchen+travis:** disable `debian-8` due to `2019.2` installation bug ([178c710](178c710))
* **kitchen+travis:** use `debian:jessie-backports` as `debian-8` ([1b9d249](1b9d249)), closes [saltstack-formulas#50](https://github.com/myii/template-formula/issues/50) [/github.com/vmware-archive/salt-pack/issues/657#issuecomment-467932962](https://github.com//github.com/saltstack/salt-pack/issues/657/issues/issuecomment-467932962)
* **travis:** include `commitlint` stage ([6659a69](6659a69))
* **travis:** prevent `release` stage running for PRs ([3a072c7](3a072c7)), closes [/travis-ci.com/saltstack-formulas/template-formula/jobs/180068519#L466](https://github.com//travis-ci.com/saltstack-formulas/template-formula/jobs/180068519/issues/L466) [/github.com/saltstack-formulas/pull/42#issuecomment-466446324](https://github.com//github.com/saltstack-formulas/template-formula/pull/42/issues/issuecomment-466446324)
* **travis:** remove obsolete `markdown-toc` process ([97fbb60](97fbb60))
* **travis:** remove obsolete check based on `$TRAVIS_TEST_RESULT` ([6df9c95](6df9c95))
* **travis:** remove unavailable files from `markdown-toc` process ([3148f0d](3148f0d))

### Documentation

* **changelog:** add missing entry under `v0.3.2` ([50352b5](50352b5))
* **changelog:** merge previous `rst` into new `md` format ([2b4e485](2b4e485))
* **changelog:** remove erroneous "closes" used by `semantic-release` ([be4571d](be4571d))
* **components:** update for separation of `pkg`, `config` & `service` ([726fcab](726fcab))
* **contributing:** add basic introductory text before the TOC ([45ccaf6](45ccaf6))
* **contributing:** add commit message formatting instructions ([fb3d173](fb3d173))
* **contributing:** add documentation contribution guidelines ([dff0ee8](dff0ee8))
* **contributing:** add TOC to match all other pages ([7b1a2a9](7b1a2a9))
* **contributing:** centre-align version bump columns in table ([a238cae](a238cae))
* **contributing:** convert to `.rst` and move to `docs` subdir ([474f318](474f318))
* **contributing:** create blank template ([3633e8f](3633e8f))
* **contributing:** modify quoted heading to prevent TOC inclusion ([abcb6ef](abcb6ef))
* **contributing:** separate `BREAKING CHANGE` under its own heading ([ee053d7](ee053d7))
* **contributing:** update with sub-headings and `commitlint` details ([ea2c9a4](ea2c9a4))
* **index:** add `CONTRIBUTING` to the `toctree` ([0c98e67](0c98e67))
* **readme:** add Read the Docs build status badge ([f47797d](f47797d))
* **readme:** add suggested improvement to `template.service.clean` ([bf1039c](bf1039c))
* **readme:** convert note into a heading ([5f2d789](5f2d789))
* **readme:** fix typos ([007159a](007159a))
* **readme:** move under `docs` subdir to access in both GitHub and RTD ([c92f674](c92f674))
* **readme:** update heading markers for consistency ([5a2bea8](5a2bea8))
* **rtd:** add basic `docs/conf.py` to allow additional customisation ([18d3924](18d3924))
* **rtd:** add basic `index.rst` to allow RTD to produce docs ([f02139f](f02139f))
* **rtd:** add comment to CSS file for overriding in-use Sphinx theme ([f237364](f237364))
* **rtd:** clean up numerous issues and inconsistencies ([ad5a8b8](ad5a8b8))
* **rtd:** use internal link targets at the top of each `.rst` file ([da09528](da09528))
* **tofs:** add more sub-headings to ease document navigation ([2c5dc21](2c5dc21))
* **tofs:** apply language formatting to source code blocks ([0638413](0638413))
* **tofs:** explain how all parts of the `source` can be customised ([2f82eb5](2f82eb5)), closes [saltstack-formulas#44](https://github.com/myii/template-formula/issues/44)
* **tofs:** improve general use of language ([5105d29](5105d29))
* **tofs:** replace existing `.md` with `.rst` and add to RTD ([fd68168](fd68168))
* **tofs:** update the `files_switch` section for the updated macro ([788f732](788f732))
* **tofs:** use `{%-` for all Jinja statements ([4348df8](4348df8))
* **tofs:** use `literalinclude` of `macros.jinja` instead of code dupe ([3f0071b](3f0071b))
* **tofs:** use table to list authorship ([2f0e20f](2f0e20f))
* **yaml:** os*.yaml map files needs at least an empty dict ([dd99750](dd99750))

### Features

* **authors:** update automatically alongside `semantic-release` ([8000098](8000098))
* **kitchen+travis:** add `opensuse-leap` after resolving issues ([7614a3c](7614a3c))
* **kitchen+travis:** conduct tests on a wider range of platforms ([1348078](1348078))
* **m2r:** use `m2r` to convert automatic `.md` files to `.rst` ([dadfb37](dadfb37))
* **pkg:** add `clean` states ([422c7ac](422c7ac))
* **pkg:** use `require` requisite between `pkg` states ([6e7141b](6e7141b)), closes [/github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/jinja.py#L120](https://github.com//github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/jinja.py/issues/L120) [/github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/templates.py#L145](https://github.com//github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/templates.py/issues/L145) [/github.com/saltstack/salt/issues/10838#issuecomment-391718086](https://github.com//github.com/saltstack/salt/issues/10838/issues/issuecomment-391718086)
* **rtd:** provide custom CSS file for overriding in-use Sphinx theme ([24bd338](24bd338))
* **semantic-release:** configure for this formula ([cbcfd75](cbcfd75))
* **toc:** use `markdown-toc` directly to update inline ([a5bae1e](a5bae1e))
* **tofs:** implement backwards-compatible TOFSv2 for configurability ([068a94d](068a94d)), closes [/freenode.logbot.info/saltstack-formulas/20190214#c1995273](https://github.com//freenode.logbot.info/saltstack-formulas/20190214/issues/c1995273) [/freenode.logbot.info/saltstack-formulas/20190214#c1995487](https://github.com//freenode.logbot.info/saltstack-formulas/20190214/issues/c1995487)

### Reverts

* **kitchen+travis:** disable `debian-8` due to `2019.2` bug ([e8f0f7e](e8f0f7e))

### Tests

* **inspec:** update `supports` for all platforms added ([42f93b3](42f93b3))

### BREAKING CHANGES

* **states:** Wholesale state ID changes will break implementations
that are relying on the previous state IDs for requisite purposes.
* **pkg:** Changing the `pkg` directory to `package` will break
implementations that are depending on `pkg` for `include` or `sls`-based
requisite purposes.
myii pushed a commit to myii/template-formula that referenced this pull request Mar 3, 2019
# [1.0.0](v0.2.0...v1.0.0) (2019-03-03)

### Bug Fixes

* **pillar:** fix `os_family` typo ([3f89c12](3f89c12))
* **tofs:** update comments in `files_switch` macro for new method ([3fa3640](3fa3640))
* **tofs:** use `tpldir` derivative `topdir` for pillar (config) paths ([5e9df00](5e9df00))

### Code Refactoring

* **components:** split components into separate subdirs ([d957055](d957055)), closes [/github.com/saltstack-formulas/pull/48#pullrequestreview-207182085](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/pullrequestreview-207182085) [/github.com/saltstack-formulas/pull/48#discussion_r259805312](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259805312)
* **include+require:** use variable for duplicate values ([4443518](4443518))
* **kitchen:** prefer `kitchen.yml` to `.kitchen.yml` ([3860bf9](3860bf9))
* **macros:** use `tplroot` instead of `topdir` to match `tpldata` ([923b459](923b459))
* **pkg:** change to `package` instead ([2cd82e5](2cd82e5)), closes [/github.com/saltstack-formulas/pull/48#discussion_r259951123](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259951123)
* **pkg:** move `pkg` related components into separate directory ([c21f82b](c21f82b))
* **states:** set state IDs based on a dependable structure ([6690ee6](6690ee6)), closes [/github.com/saltstack-formulas/pull/48#discussion_r259953473](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259953473) [/github.com/saltstack-formulas/pull/48#discussion_r259956996](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259956996)
* **topdir:** use for `include` and `require` except `init.sls` ([a218e91](a218e91))
* **tpldir:** use `topdir` globally in place of `tpldir` ([2838bc9](2838bc9))
* **tpldir:** use `tpldir` or derivatives to make formula portable ([52d03d8](52d03d8)), closes [saltstack-formulas#22](https://github.com/myii/template-formula/issues/22)
* **tplroot:** use `tplroot` instead of `topdir` to match `tpldata` ([b7356b0](b7356b0))

### Continuous Integration

* **kitchen:** check for repos updates before trying package installation ([b632383](b632383))
* **kitchen:** improve comments about `opensuse` problems encountered ([c246939](c246939))
* **kitchen:** specify `image` explicitly for each platform ([b25fbdc](b25fbdc))
* **kitchen:** use `salt-minion` version of `opensuse` to ensure tests run ([99b073a](99b073a))
* **kitchen+travis:** disable `debian-8` due to `2019.2` installation bug ([178c710](178c710))
* **kitchen+travis:** use `debian:jessie-backports` as `debian-8` ([1b9d249](1b9d249)), closes [saltstack-formulas#50](https://github.com/myii/template-formula/issues/50) [/github.com/vmware-archive/salt-pack/issues/657#issuecomment-467932962](https://github.com//github.com/saltstack/salt-pack/issues/657/issues/issuecomment-467932962)
* **travis:** include `commitlint` stage ([6659a69](6659a69))
* **travis:** prevent `release` stage running for PRs ([3a072c7](3a072c7)), closes [/travis-ci.com/saltstack-formulas/template-formula/jobs/180068519#L466](https://github.com//travis-ci.com/saltstack-formulas/template-formula/jobs/180068519/issues/L466) [/github.com/saltstack-formulas/pull/42#issuecomment-466446324](https://github.com//github.com/saltstack-formulas/template-formula/pull/42/issues/issuecomment-466446324)
* **travis:** remove obsolete `markdown-toc` process ([97fbb60](97fbb60))
* **travis:** remove obsolete check based on `$TRAVIS_TEST_RESULT` ([6df9c95](6df9c95))
* **travis:** remove unavailable files from `markdown-toc` process ([3148f0d](3148f0d))

### Documentation

* **changelog:** add missing entry under `v0.3.2` ([50352b5](50352b5))
* **changelog:** merge previous `rst` into new `md` format ([2b4e485](2b4e485))
* **changelog:** remove erroneous "closes" used by `semantic-release` ([be4571d](be4571d))
* **components:** update for separation of `pkg`, `config` & `service` ([726fcab](726fcab))
* **contributing:** add basic introductory text before the TOC ([45ccaf6](45ccaf6))
* **contributing:** add commit message formatting instructions ([fb3d173](fb3d173))
* **contributing:** add documentation contribution guidelines ([dff0ee8](dff0ee8))
* **contributing:** add TOC to match all other pages ([7b1a2a9](7b1a2a9))
* **contributing:** centre-align version bump columns in table ([a238cae](a238cae))
* **contributing:** convert to `.rst` and move to `docs` subdir ([474f318](474f318))
* **contributing:** create blank template ([3633e8f](3633e8f))
* **contributing:** modify quoted heading to prevent TOC inclusion ([abcb6ef](abcb6ef))
* **contributing:** separate `BREAKING CHANGE` under its own heading ([ee053d7](ee053d7))
* **contributing:** update with sub-headings and `commitlint` details ([ea2c9a4](ea2c9a4))
* **index:** add `CONTRIBUTING` to the `toctree` ([0c98e67](0c98e67))
* **readme:** add Read the Docs build status badge ([f47797d](f47797d))
* **readme:** add suggested improvement to `template.service.clean` ([bf1039c](bf1039c))
* **readme:** convert note into a heading ([5f2d789](5f2d789))
* **readme:** fix typos ([007159a](007159a))
* **readme:** move under `docs` subdir to access in both GitHub and RTD ([c92f674](c92f674))
* **readme:** update heading markers for consistency ([5a2bea8](5a2bea8))
* **rtd:** add basic `docs/conf.py` to allow additional customisation ([18d3924](18d3924))
* **rtd:** add basic `index.rst` to allow RTD to produce docs ([f02139f](f02139f))
* **rtd:** add comment to CSS file for overriding in-use Sphinx theme ([f237364](f237364))
* **rtd:** clean up numerous issues and inconsistencies ([ad5a8b8](ad5a8b8))
* **rtd:** use internal link targets at the top of each `.rst` file ([da09528](da09528))
* **tofs:** add more sub-headings to ease document navigation ([2c5dc21](2c5dc21))
* **tofs:** apply language formatting to source code blocks ([0638413](0638413))
* **tofs:** explain how all parts of the `source` can be customised ([2f82eb5](2f82eb5)), closes [saltstack-formulas#44](https://github.com/myii/template-formula/issues/44)
* **tofs:** improve general use of language ([5105d29](5105d29))
* **tofs:** replace existing `.md` with `.rst` and add to RTD ([fd68168](fd68168))
* **tofs:** update the `files_switch` section for the updated macro ([788f732](788f732))
* **tofs:** use `{%-` for all Jinja statements ([4348df8](4348df8))
* **tofs:** use `literalinclude` of `macros.jinja` instead of code dupe ([3f0071b](3f0071b))
* **tofs:** use table to list authorship ([2f0e20f](2f0e20f))
* **yaml:** os*.yaml map files needs at least an empty dict ([dd99750](dd99750))

### Features

* **authors:** update automatically alongside `semantic-release` ([8000098](8000098))
* **kitchen+travis:** add `opensuse-leap` after resolving issues ([7614a3c](7614a3c))
* **kitchen+travis:** conduct tests on a wider range of platforms ([1348078](1348078))
* **m2r:** use `m2r` to convert automatic `.md` files to `.rst` ([af75d87](af75d87))
* **pkg:** add `clean` states ([422c7ac](422c7ac))
* **pkg:** use `require` requisite between `pkg` states ([6e7141b](6e7141b)), closes [/github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/jinja.py#L120](https://github.com//github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/jinja.py/issues/L120) [/github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/templates.py#L145](https://github.com//github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/templates.py/issues/L145) [/github.com/saltstack/salt/issues/10838#issuecomment-391718086](https://github.com//github.com/saltstack/salt/issues/10838/issues/issuecomment-391718086)
* **rtd:** provide custom CSS file for overriding in-use Sphinx theme ([24bd338](24bd338))
* **semantic-release:** configure for this formula ([cbcfd75](cbcfd75))
* **toc:** use `markdown-toc` directly to update inline ([a5bae1e](a5bae1e))
* **tofs:** implement backwards-compatible TOFSv2 for configurability ([068a94d](068a94d)), closes [/freenode.logbot.info/saltstack-formulas/20190214#c1995273](https://github.com//freenode.logbot.info/saltstack-formulas/20190214/issues/c1995273) [/freenode.logbot.info/saltstack-formulas/20190214#c1995487](https://github.com//freenode.logbot.info/saltstack-formulas/20190214/issues/c1995487)

### Reverts

* **kitchen+travis:** disable `debian-8` due to `2019.2` bug ([e8f0f7e](e8f0f7e))

### Tests

* **inspec:** update `supports` for all platforms added ([42f93b3](42f93b3))

### BREAKING CHANGES

* **states:** Wholesale state ID changes will break implementations
that are relying on the previous state IDs for requisite purposes.
* **pkg:** Changing the `pkg` directory to `package` will break
implementations that are depending on `pkg` for `include` or `sls`-based
requisite purposes.
myii pushed a commit to myii/template-formula that referenced this pull request Mar 3, 2019
# [1.0.0](v0.2.0...v1.0.0) (2019-03-03)

### Bug Fixes

* **pillar:** fix `os_family` typo ([3f89c12](3f89c12))
* **tofs:** update comments in `files_switch` macro for new method ([3fa3640](3fa3640))
* **tofs:** use `tpldir` derivative `topdir` for pillar (config) paths ([5e9df00](5e9df00))

### Code Refactoring

* **components:** split components into separate subdirs ([d957055](d957055)), closes [/github.com/saltstack-formulas/pull/48#pullrequestreview-207182085](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/pullrequestreview-207182085) [/github.com/saltstack-formulas/pull/48#discussion_r259805312](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259805312)
* **include+require:** use variable for duplicate values ([4443518](4443518))
* **kitchen:** prefer `kitchen.yml` to `.kitchen.yml` ([3860bf9](3860bf9))
* **macros:** use `tplroot` instead of `topdir` to match `tpldata` ([923b459](923b459))
* **pkg:** change to `package` instead ([2cd82e5](2cd82e5)), closes [/github.com/saltstack-formulas/pull/48#discussion_r259951123](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259951123)
* **pkg:** move `pkg` related components into separate directory ([c21f82b](c21f82b))
* **states:** set state IDs based on a dependable structure ([6690ee6](6690ee6)), closes [/github.com/saltstack-formulas/pull/48#discussion_r259953473](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259953473) [/github.com/saltstack-formulas/pull/48#discussion_r259956996](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259956996)
* **topdir:** use for `include` and `require` except `init.sls` ([a218e91](a218e91))
* **tpldir:** use `topdir` globally in place of `tpldir` ([2838bc9](2838bc9))
* **tpldir:** use `tpldir` or derivatives to make formula portable ([52d03d8](52d03d8)), closes [saltstack-formulas#22](https://github.com/myii/template-formula/issues/22)
* **tplroot:** use `tplroot` instead of `topdir` to match `tpldata` ([b7356b0](b7356b0))

### Continuous Integration

* **kitchen:** check for repos updates before trying package installation ([b632383](b632383))
* **kitchen:** improve comments about `opensuse` problems encountered ([c246939](c246939))
* **kitchen:** specify `image` explicitly for each platform ([b25fbdc](b25fbdc))
* **kitchen:** use `salt-minion` version of `opensuse` to ensure tests run ([99b073a](99b073a))
* **kitchen+travis:** disable `debian-8` due to `2019.2` installation bug ([178c710](178c710))
* **kitchen+travis:** use `debian:jessie-backports` as `debian-8` ([1b9d249](1b9d249)), closes [saltstack-formulas#50](https://github.com/myii/template-formula/issues/50) [/github.com/vmware-archive/salt-pack/issues/657#issuecomment-467932962](https://github.com//github.com/saltstack/salt-pack/issues/657/issues/issuecomment-467932962)
* **travis:** include `commitlint` stage ([6659a69](6659a69))
* **travis:** prevent `release` stage running for PRs ([3a072c7](3a072c7)), closes [/travis-ci.com/saltstack-formulas/template-formula/jobs/180068519#L466](https://github.com//travis-ci.com/saltstack-formulas/template-formula/jobs/180068519/issues/L466) [/github.com/saltstack-formulas/pull/42#issuecomment-466446324](https://github.com//github.com/saltstack-formulas/template-formula/pull/42/issues/issuecomment-466446324)
* **travis:** remove obsolete `markdown-toc` process ([97fbb60](97fbb60))
* **travis:** remove obsolete check based on `$TRAVIS_TEST_RESULT` ([6df9c95](6df9c95))
* **travis:** remove unavailable files from `markdown-toc` process ([3148f0d](3148f0d))

### Documentation

* **changelog:** add missing entry under `v0.3.2` ([50352b5](50352b5))
* **changelog:** merge previous `rst` into new `md` format ([2b4e485](2b4e485))
* **changelog:** remove erroneous "closes" used by `semantic-release` ([be4571d](be4571d))
* **components:** update for separation of `pkg`, `config` & `service` ([726fcab](726fcab))
* **contributing:** add basic introductory text before the TOC ([45ccaf6](45ccaf6))
* **contributing:** add commit message formatting instructions ([fb3d173](fb3d173))
* **contributing:** add documentation contribution guidelines ([dff0ee8](dff0ee8))
* **contributing:** add TOC to match all other pages ([7b1a2a9](7b1a2a9))
* **contributing:** centre-align version bump columns in table ([a238cae](a238cae))
* **contributing:** convert to `.rst` and move to `docs` subdir ([474f318](474f318))
* **contributing:** create blank template ([3633e8f](3633e8f))
* **contributing:** modify quoted heading to prevent TOC inclusion ([abcb6ef](abcb6ef))
* **contributing:** separate `BREAKING CHANGE` under its own heading ([ee053d7](ee053d7))
* **contributing:** update with sub-headings and `commitlint` details ([ea2c9a4](ea2c9a4))
* **index:** add `CONTRIBUTING` to the `toctree` ([0c98e67](0c98e67))
* **readme:** add Read the Docs build status badge ([f47797d](f47797d))
* **readme:** add suggested improvement to `template.service.clean` ([bf1039c](bf1039c))
* **readme:** convert note into a heading ([5f2d789](5f2d789))
* **readme:** fix typos ([007159a](007159a))
* **readme:** move under `docs` subdir to access in both GitHub and RTD ([c92f674](c92f674))
* **readme:** update heading markers for consistency ([5a2bea8](5a2bea8))
* **rtd:** add basic `docs/conf.py` to allow additional customisation ([18d3924](18d3924))
* **rtd:** add basic `index.rst` to allow RTD to produce docs ([f02139f](f02139f))
* **rtd:** add comment to CSS file for overriding in-use Sphinx theme ([f237364](f237364))
* **rtd:** clean up numerous issues and inconsistencies ([ad5a8b8](ad5a8b8))
* **rtd:** use internal link targets at the top of each `.rst` file ([da09528](da09528))
* **tofs:** add more sub-headings to ease document navigation ([2c5dc21](2c5dc21))
* **tofs:** apply language formatting to source code blocks ([0638413](0638413))
* **tofs:** explain how all parts of the `source` can be customised ([2f82eb5](2f82eb5)), closes [saltstack-formulas#44](https://github.com/myii/template-formula/issues/44)
* **tofs:** improve general use of language ([5105d29](5105d29))
* **tofs:** replace existing `.md` with `.rst` and add to RTD ([fd68168](fd68168))
* **tofs:** update the `files_switch` section for the updated macro ([788f732](788f732))
* **tofs:** use `{%-` for all Jinja statements ([4348df8](4348df8))
* **tofs:** use `literalinclude` of `macros.jinja` instead of code dupe ([3f0071b](3f0071b))
* **tofs:** use table to list authorship ([2f0e20f](2f0e20f))
* **yaml:** os*.yaml map files needs at least an empty dict ([dd99750](dd99750))

### Features

* **authors:** update automatically alongside `semantic-release` ([8000098](8000098))
* **kitchen+travis:** add `opensuse-leap` after resolving issues ([7614a3c](7614a3c))
* **kitchen+travis:** conduct tests on a wider range of platforms ([1348078](1348078))
* **m2r:** use `m2r` to convert automatic `.md` files to `.rst` ([6d68925](6d68925))
* **pkg:** add `clean` states ([422c7ac](422c7ac))
* **pkg:** use `require` requisite between `pkg` states ([6e7141b](6e7141b)), closes [/github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/jinja.py#L120](https://github.com//github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/jinja.py/issues/L120) [/github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/templates.py#L145](https://github.com//github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/templates.py/issues/L145) [/github.com/saltstack/salt/issues/10838#issuecomment-391718086](https://github.com//github.com/saltstack/salt/issues/10838/issues/issuecomment-391718086)
* **rtd:** provide custom CSS file for overriding in-use Sphinx theme ([24bd338](24bd338))
* **semantic-release:** configure for this formula ([cbcfd75](cbcfd75))
* **toc:** use `markdown-toc` directly to update inline ([a5bae1e](a5bae1e))
* **tofs:** implement backwards-compatible TOFSv2 for configurability ([068a94d](068a94d)), closes [/freenode.logbot.info/saltstack-formulas/20190214#c1995273](https://github.com//freenode.logbot.info/saltstack-formulas/20190214/issues/c1995273) [/freenode.logbot.info/saltstack-formulas/20190214#c1995487](https://github.com//freenode.logbot.info/saltstack-formulas/20190214/issues/c1995487)

### Reverts

* **kitchen+travis:** disable `debian-8` due to `2019.2` bug ([e8f0f7e](e8f0f7e))

### Tests

* **inspec:** update `supports` for all platforms added ([42f93b3](42f93b3))

### BREAKING CHANGES

* **states:** Wholesale state ID changes will break implementations
that are relying on the previous state IDs for requisite purposes.
* **pkg:** Changing the `pkg` directory to `package` will break
implementations that are depending on `pkg` for `include` or `sls`-based
requisite purposes.
myii pushed a commit to myii/template-formula that referenced this pull request Mar 3, 2019
# [1.0.0](v0.2.0...v1.0.0) (2019-03-03)

### Bug Fixes

* **pillar:** fix `os_family` typo ([3f89c12](3f89c12))
* **tofs:** update comments in `files_switch` macro for new method ([3fa3640](3fa3640))
* **tofs:** use `tpldir` derivative `topdir` for pillar (config) paths ([5e9df00](5e9df00))

### Code Refactoring

* **components:** split components into separate subdirs ([d957055](d957055)), closes [/github.com/saltstack-formulas/pull/48#pullrequestreview-207182085](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/pullrequestreview-207182085) [/github.com/saltstack-formulas/pull/48#discussion_r259805312](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259805312)
* **include+require:** use variable for duplicate values ([4443518](4443518))
* **kitchen:** prefer `kitchen.yml` to `.kitchen.yml` ([3860bf9](3860bf9))
* **macros:** use `tplroot` instead of `topdir` to match `tpldata` ([923b459](923b459))
* **pkg:** change to `package` instead ([2cd82e5](2cd82e5)), closes [/github.com/saltstack-formulas/pull/48#discussion_r259951123](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259951123)
* **pkg:** move `pkg` related components into separate directory ([c21f82b](c21f82b))
* **states:** set state IDs based on a dependable structure ([6690ee6](6690ee6)), closes [/github.com/saltstack-formulas/pull/48#discussion_r259953473](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259953473) [/github.com/saltstack-formulas/pull/48#discussion_r259956996](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259956996)
* **topdir:** use for `include` and `require` except `init.sls` ([a218e91](a218e91))
* **tpldir:** use `topdir` globally in place of `tpldir` ([2838bc9](2838bc9))
* **tpldir:** use `tpldir` or derivatives to make formula portable ([52d03d8](52d03d8)), closes [saltstack-formulas#22](https://github.com/myii/template-formula/issues/22)
* **tplroot:** use `tplroot` instead of `topdir` to match `tpldata` ([b7356b0](b7356b0))

### Continuous Integration

* **kitchen:** check for repos updates before trying package installation ([b632383](b632383))
* **kitchen:** improve comments about `opensuse` problems encountered ([c246939](c246939))
* **kitchen:** specify `image` explicitly for each platform ([b25fbdc](b25fbdc))
* **kitchen:** use `salt-minion` version of `opensuse` to ensure tests run ([99b073a](99b073a))
* **kitchen+travis:** disable `debian-8` due to `2019.2` installation bug ([178c710](178c710))
* **kitchen+travis:** use `debian:jessie-backports` as `debian-8` ([1b9d249](1b9d249)), closes [saltstack-formulas#50](https://github.com/myii/template-formula/issues/50) [/github.com/vmware-archive/salt-pack/issues/657#issuecomment-467932962](https://github.com//github.com/saltstack/salt-pack/issues/657/issues/issuecomment-467932962)
* **travis:** include `commitlint` stage ([6659a69](6659a69))
* **travis:** prevent `release` stage running for PRs ([3a072c7](3a072c7)), closes [/travis-ci.com/saltstack-formulas/template-formula/jobs/180068519#L466](https://github.com//travis-ci.com/saltstack-formulas/template-formula/jobs/180068519/issues/L466) [/github.com/saltstack-formulas/pull/42#issuecomment-466446324](https://github.com//github.com/saltstack-formulas/template-formula/pull/42/issues/issuecomment-466446324)
* **travis:** remove obsolete `markdown-toc` process ([97fbb60](97fbb60))
* **travis:** remove obsolete check based on `$TRAVIS_TEST_RESULT` ([6df9c95](6df9c95))
* **travis:** remove unavailable files from `markdown-toc` process ([3148f0d](3148f0d))

### Documentation

* **changelog:** add missing entry under `v0.3.2` ([50352b5](50352b5))
* **changelog:** merge previous `rst` into new `md` format ([2b4e485](2b4e485))
* **changelog:** remove erroneous "closes" used by `semantic-release` ([be4571d](be4571d))
* **components:** update for separation of `pkg`, `config` & `service` ([726fcab](726fcab))
* **contributing:** add basic introductory text before the TOC ([45ccaf6](45ccaf6))
* **contributing:** add commit message formatting instructions ([fb3d173](fb3d173))
* **contributing:** add documentation contribution guidelines ([dff0ee8](dff0ee8))
* **contributing:** add TOC to match all other pages ([7b1a2a9](7b1a2a9))
* **contributing:** centre-align version bump columns in table ([a238cae](a238cae))
* **contributing:** convert to `.rst` and move to `docs` subdir ([474f318](474f318))
* **contributing:** create blank template ([3633e8f](3633e8f))
* **contributing:** modify quoted heading to prevent TOC inclusion ([abcb6ef](abcb6ef))
* **contributing:** separate `BREAKING CHANGE` under its own heading ([ee053d7](ee053d7))
* **contributing:** update with sub-headings and `commitlint` details ([ea2c9a4](ea2c9a4))
* **index:** add `CONTRIBUTING` to the `toctree` ([0c98e67](0c98e67))
* **readme:** add Read the Docs build status badge ([f47797d](f47797d))
* **readme:** add suggested improvement to `template.service.clean` ([bf1039c](bf1039c))
* **readme:** convert note into a heading ([5f2d789](5f2d789))
* **readme:** fix typos ([007159a](007159a))
* **readme:** move under `docs` subdir to access in both GitHub and RTD ([c92f674](c92f674))
* **readme:** update heading markers for consistency ([5a2bea8](5a2bea8))
* **rtd:** add basic `docs/conf.py` to allow additional customisation ([18d3924](18d3924))
* **rtd:** add basic `index.rst` to allow RTD to produce docs ([f02139f](f02139f))
* **rtd:** add comment to CSS file for overriding in-use Sphinx theme ([f237364](f237364))
* **rtd:** clean up numerous issues and inconsistencies ([ad5a8b8](ad5a8b8))
* **rtd:** use internal link targets at the top of each `.rst` file ([da09528](da09528))
* **tofs:** add more sub-headings to ease document navigation ([2c5dc21](2c5dc21))
* **tofs:** apply language formatting to source code blocks ([0638413](0638413))
* **tofs:** explain how all parts of the `source` can be customised ([2f82eb5](2f82eb5)), closes [saltstack-formulas#44](https://github.com/myii/template-formula/issues/44)
* **tofs:** improve general use of language ([5105d29](5105d29))
* **tofs:** replace existing `.md` with `.rst` and add to RTD ([fd68168](fd68168))
* **tofs:** update the `files_switch` section for the updated macro ([788f732](788f732))
* **tofs:** use `{%-` for all Jinja statements ([4348df8](4348df8))
* **tofs:** use `literalinclude` of `macros.jinja` instead of code dupe ([3f0071b](3f0071b))
* **tofs:** use table to list authorship ([2f0e20f](2f0e20f))
* **yaml:** os*.yaml map files needs at least an empty dict ([dd99750](dd99750))

### Features

* **authors:** update automatically alongside `semantic-release` ([8000098](8000098))
* **kitchen+travis:** add `opensuse-leap` after resolving issues ([7614a3c](7614a3c))
* **kitchen+travis:** conduct tests on a wider range of platforms ([1348078](1348078))
* **m2r:** use `m2r` to convert automatic `.md` files to `.rst` ([dd96b16](dd96b16))
* **pkg:** add `clean` states ([422c7ac](422c7ac))
* **pkg:** use `require` requisite between `pkg` states ([6e7141b](6e7141b)), closes [/github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/jinja.py#L120](https://github.com//github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/jinja.py/issues/L120) [/github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/templates.py#L145](https://github.com//github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/templates.py/issues/L145) [/github.com/saltstack/salt/issues/10838#issuecomment-391718086](https://github.com//github.com/saltstack/salt/issues/10838/issues/issuecomment-391718086)
* **rtd:** provide custom CSS file for overriding in-use Sphinx theme ([24bd338](24bd338))
* **semantic-release:** configure for this formula ([cbcfd75](cbcfd75))
* **toc:** use `markdown-toc` directly to update inline ([a5bae1e](a5bae1e))
* **tofs:** implement backwards-compatible TOFSv2 for configurability ([068a94d](068a94d)), closes [/freenode.logbot.info/saltstack-formulas/20190214#c1995273](https://github.com//freenode.logbot.info/saltstack-formulas/20190214/issues/c1995273) [/freenode.logbot.info/saltstack-formulas/20190214#c1995487](https://github.com//freenode.logbot.info/saltstack-formulas/20190214/issues/c1995487)

### Reverts

* **kitchen+travis:** disable `debian-8` due to `2019.2` bug ([e8f0f7e](e8f0f7e))

### Tests

* **inspec:** update `supports` for all platforms added ([42f93b3](42f93b3))

### BREAKING CHANGES

* **states:** Wholesale state ID changes will break implementations
that are relying on the previous state IDs for requisite purposes.
* **pkg:** Changing the `pkg` directory to `package` will break
implementations that are depending on `pkg` for `include` or `sls`-based
requisite purposes.
myii pushed a commit to myii/template-formula that referenced this pull request Mar 3, 2019
# [1.0.0](v0.2.0...v1.0.0) (2019-03-03)

### Bug Fixes

* **pillar:** fix `os_family` typo ([3f89c12](3f89c12))
* **tofs:** update comments in `files_switch` macro for new method ([3fa3640](3fa3640))
* **tofs:** use `tpldir` derivative `topdir` for pillar (config) paths ([5e9df00](5e9df00))

### Code Refactoring

* **components:** split components into separate subdirs ([d957055](d957055)), closes [/github.com/saltstack-formulas/pull/48#pullrequestreview-207182085](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/pullrequestreview-207182085) [/github.com/saltstack-formulas/pull/48#discussion_r259805312](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259805312)
* **include+require:** use variable for duplicate values ([4443518](4443518))
* **kitchen:** prefer `kitchen.yml` to `.kitchen.yml` ([3860bf9](3860bf9))
* **macros:** use `tplroot` instead of `topdir` to match `tpldata` ([923b459](923b459))
* **pkg:** change to `package` instead ([2cd82e5](2cd82e5)), closes [/github.com/saltstack-formulas/pull/48#discussion_r259951123](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259951123)
* **pkg:** move `pkg` related components into separate directory ([c21f82b](c21f82b))
* **states:** set state IDs based on a dependable structure ([6690ee6](6690ee6)), closes [/github.com/saltstack-formulas/pull/48#discussion_r259953473](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259953473) [/github.com/saltstack-formulas/pull/48#discussion_r259956996](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259956996)
* **topdir:** use for `include` and `require` except `init.sls` ([a218e91](a218e91))
* **tpldir:** use `topdir` globally in place of `tpldir` ([2838bc9](2838bc9))
* **tpldir:** use `tpldir` or derivatives to make formula portable ([52d03d8](52d03d8)), closes [saltstack-formulas#22](https://github.com/myii/template-formula/issues/22)
* **tplroot:** use `tplroot` instead of `topdir` to match `tpldata` ([b7356b0](b7356b0))

### Continuous Integration

* **kitchen:** check for repos updates before trying package installation ([b632383](b632383))
* **kitchen:** improve comments about `opensuse` problems encountered ([c246939](c246939))
* **kitchen:** specify `image` explicitly for each platform ([b25fbdc](b25fbdc))
* **kitchen:** use `salt-minion` version of `opensuse` to ensure tests run ([99b073a](99b073a))
* **kitchen+travis:** disable `debian-8` due to `2019.2` installation bug ([178c710](178c710))
* **kitchen+travis:** use `debian:jessie-backports` as `debian-8` ([1b9d249](1b9d249)), closes [saltstack-formulas#50](https://github.com/myii/template-formula/issues/50) [/github.com/vmware-archive/salt-pack/issues/657#issuecomment-467932962](https://github.com//github.com/saltstack/salt-pack/issues/657/issues/issuecomment-467932962)
* **travis:** include `commitlint` stage ([6659a69](6659a69))
* **travis:** prevent `release` stage running for PRs ([3a072c7](3a072c7)), closes [/travis-ci.com/saltstack-formulas/template-formula/jobs/180068519#L466](https://github.com//travis-ci.com/saltstack-formulas/template-formula/jobs/180068519/issues/L466) [/github.com/saltstack-formulas/pull/42#issuecomment-466446324](https://github.com//github.com/saltstack-formulas/template-formula/pull/42/issues/issuecomment-466446324)
* **travis:** remove obsolete `markdown-toc` process ([97fbb60](97fbb60))
* **travis:** remove obsolete check based on `$TRAVIS_TEST_RESULT` ([6df9c95](6df9c95))
* **travis:** remove unavailable files from `markdown-toc` process ([3148f0d](3148f0d))

### Documentation

* **changelog:** add missing entry under `v0.3.2` ([50352b5](50352b5))
* **changelog:** merge previous `rst` into new `md` format ([2b4e485](2b4e485))
* **changelog:** remove erroneous "closes" used by `semantic-release` ([be4571d](be4571d))
* **components:** update for separation of `pkg`, `config` & `service` ([726fcab](726fcab))
* **contributing:** add basic introductory text before the TOC ([45ccaf6](45ccaf6))
* **contributing:** add commit message formatting instructions ([fb3d173](fb3d173))
* **contributing:** add documentation contribution guidelines ([dff0ee8](dff0ee8))
* **contributing:** add TOC to match all other pages ([7b1a2a9](7b1a2a9))
* **contributing:** centre-align version bump columns in table ([a238cae](a238cae))
* **contributing:** convert to `.rst` and move to `docs` subdir ([474f318](474f318))
* **contributing:** create blank template ([3633e8f](3633e8f))
* **contributing:** modify quoted heading to prevent TOC inclusion ([abcb6ef](abcb6ef))
* **contributing:** separate `BREAKING CHANGE` under its own heading ([ee053d7](ee053d7))
* **contributing:** update with sub-headings and `commitlint` details ([ea2c9a4](ea2c9a4))
* **index:** add `CONTRIBUTING` to the `toctree` ([0c98e67](0c98e67))
* **readme:** add Read the Docs build status badge ([f47797d](f47797d))
* **readme:** add suggested improvement to `template.service.clean` ([bf1039c](bf1039c))
* **readme:** convert note into a heading ([5f2d789](5f2d789))
* **readme:** fix typos ([007159a](007159a))
* **readme:** move under `docs` subdir to access in both GitHub and RTD ([c92f674](c92f674))
* **readme:** update heading markers for consistency ([5a2bea8](5a2bea8))
* **rtd:** add basic `docs/conf.py` to allow additional customisation ([18d3924](18d3924))
* **rtd:** add basic `index.rst` to allow RTD to produce docs ([f02139f](f02139f))
* **rtd:** add comment to CSS file for overriding in-use Sphinx theme ([f237364](f237364))
* **rtd:** clean up numerous issues and inconsistencies ([ad5a8b8](ad5a8b8))
* **rtd:** use internal link targets at the top of each `.rst` file ([da09528](da09528))
* **tofs:** add more sub-headings to ease document navigation ([2c5dc21](2c5dc21))
* **tofs:** apply language formatting to source code blocks ([0638413](0638413))
* **tofs:** explain how all parts of the `source` can be customised ([2f82eb5](2f82eb5)), closes [saltstack-formulas#44](https://github.com/myii/template-formula/issues/44)
* **tofs:** improve general use of language ([5105d29](5105d29))
* **tofs:** replace existing `.md` with `.rst` and add to RTD ([fd68168](fd68168))
* **tofs:** update the `files_switch` section for the updated macro ([788f732](788f732))
* **tofs:** use `{%-` for all Jinja statements ([4348df8](4348df8))
* **tofs:** use `literalinclude` of `macros.jinja` instead of code dupe ([3f0071b](3f0071b))
* **tofs:** use table to list authorship ([2f0e20f](2f0e20f))
* **yaml:** os*.yaml map files needs at least an empty dict ([dd99750](dd99750))

### Features

* **authors:** update automatically alongside `semantic-release` ([8000098](8000098))
* **kitchen+travis:** add `opensuse-leap` after resolving issues ([7614a3c](7614a3c))
* **kitchen+travis:** conduct tests on a wider range of platforms ([1348078](1348078))
* **m2r:** use `m2r` to convert automatic `.md` files to `.rst` ([7646d41](7646d41))
* **pkg:** add `clean` states ([422c7ac](422c7ac))
* **pkg:** use `require` requisite between `pkg` states ([6e7141b](6e7141b)), closes [/github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/jinja.py#L120](https://github.com//github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/jinja.py/issues/L120) [/github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/templates.py#L145](https://github.com//github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/templates.py/issues/L145) [/github.com/saltstack/salt/issues/10838#issuecomment-391718086](https://github.com//github.com/saltstack/salt/issues/10838/issues/issuecomment-391718086)
* **rtd:** provide custom CSS file for overriding in-use Sphinx theme ([24bd338](24bd338))
* **semantic-release:** configure for this formula ([cbcfd75](cbcfd75))
* **toc:** use `markdown-toc` directly to update inline ([a5bae1e](a5bae1e))
* **tofs:** implement backwards-compatible TOFSv2 for configurability ([068a94d](068a94d)), closes [/freenode.logbot.info/saltstack-formulas/20190214#c1995273](https://github.com//freenode.logbot.info/saltstack-formulas/20190214/issues/c1995273) [/freenode.logbot.info/saltstack-formulas/20190214#c1995487](https://github.com//freenode.logbot.info/saltstack-formulas/20190214/issues/c1995487)

### Reverts

* **kitchen+travis:** disable `debian-8` due to `2019.2` bug ([e8f0f7e](e8f0f7e))

### Tests

* **inspec:** update `supports` for all platforms added ([42f93b3](42f93b3))

### BREAKING CHANGES

* **states:** Wholesale state ID changes will break implementations
that are relying on the previous state IDs for requisite purposes.
* **pkg:** Changing the `pkg` directory to `package` will break
implementations that are depending on `pkg` for `include` or `sls`-based
requisite purposes.
myii pushed a commit to myii/template-formula that referenced this pull request Mar 6, 2019
# [1.0.0](v0.2.0...v1.0.0) (2019-03-06)

### Bug Fixes

* **pillar:** fix `os_family` typo ([3f89c12](3f89c12))
* **tofs:** update comments in `files_switch` macro for new method ([3fa3640](3fa3640))
* **tofs:** use `tpldir` derivative `topdir` for pillar (config) paths ([5e9df00](5e9df00))

### Code Refactoring

* **components:** split components into separate subdirs ([d957055](d957055)), closes [/github.com/saltstack-formulas/pull/48#pullrequestreview-207182085](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/pullrequestreview-207182085) [/github.com/saltstack-formulas/pull/48#discussion_r259805312](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259805312)
* **include+require:** use variable for duplicate values ([4443518](4443518))
* **kitchen:** prefer `kitchen.yml` to `.kitchen.yml` ([3860bf9](3860bf9))
* **macros:** use `tplroot` instead of `topdir` to match `tpldata` ([923b459](923b459))
* **pkg:** change to `package` instead ([2cd82e5](2cd82e5)), closes [/github.com/saltstack-formulas/pull/48#discussion_r259951123](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259951123)
* **pkg:** move `pkg` related components into separate directory ([c21f82b](c21f82b))
* **states:** set state IDs based on a dependable structure ([6690ee6](6690ee6)), closes [/github.com/saltstack-formulas/pull/48#discussion_r259953473](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259953473) [/github.com/saltstack-formulas/pull/48#discussion_r259956996](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259956996)
* **topdir:** use for `include` and `require` except `init.sls` ([a218e91](a218e91))
* **tpldir:** use `topdir` globally in place of `tpldir` ([2838bc9](2838bc9))
* **tpldir:** use `tpldir` or derivatives to make formula portable ([52d03d8](52d03d8)), closes [saltstack-formulas#22](https://github.com/myii/template-formula/issues/22)
* **tplroot:** use `tplroot` instead of `topdir` to match `tpldata` ([b7356b0](b7356b0))

### Continuous Integration

* **kitchen:** check for repos updates before trying package installation ([b632383](b632383))
* **kitchen:** improve comments about `opensuse` problems encountered ([c246939](c246939))
* **kitchen:** specify `image` explicitly for each platform ([b25fbdc](b25fbdc))
* **kitchen:** use `salt-minion` version of `opensuse` to ensure tests run ([99b073a](99b073a))
* **kitchen+travis:** disable `debian-8` due to `2019.2` installation bug ([178c710](178c710))
* **kitchen+travis:** use `debian:jessie-backports` as `debian-8` ([1b9d249](1b9d249)), closes [saltstack-formulas#50](https://github.com/myii/template-formula/issues/50) [/github.com/vmware-archive/salt-pack/issues/657#issuecomment-467932962](https://github.com//github.com/saltstack/salt-pack/issues/657/issues/issuecomment-467932962)
* **travis:** include `commitlint` stage ([6659a69](6659a69))
* **travis:** prevent `release` stage running for PRs ([3a072c7](3a072c7)), closes [/travis-ci.com/saltstack-formulas/template-formula/jobs/180068519#L466](https://github.com//travis-ci.com/saltstack-formulas/template-formula/jobs/180068519/issues/L466) [/github.com/saltstack-formulas/pull/42#issuecomment-466446324](https://github.com//github.com/saltstack-formulas/template-formula/pull/42/issues/issuecomment-466446324)
* **travis:** remove obsolete `markdown-toc` process ([97fbb60](97fbb60))
* **travis:** remove obsolete check based on `$TRAVIS_TEST_RESULT` ([6df9c95](6df9c95))
* **travis:** remove unavailable files from `markdown-toc` process ([3148f0d](3148f0d))

### Documentation

* **changelog:** add missing entry under `v0.3.2` ([50352b5](50352b5))
* **changelog:** merge previous `rst` into new `md` format ([2b4e485](2b4e485))
* **changelog:** remove erroneous "closes" used by `semantic-release` ([be4571d](be4571d))
* **components:** update for separation of `pkg`, `config` & `service` ([726fcab](726fcab))
* **contributing:** add basic introductory text before the TOC ([45ccaf6](45ccaf6))
* **contributing:** add commit message formatting instructions ([fb3d173](fb3d173))
* **contributing:** add documentation contribution guidelines ([dff0ee8](dff0ee8))
* **contributing:** add TOC to match all other pages ([7b1a2a9](7b1a2a9))
* **contributing:** centre-align version bump columns in table ([a238cae](a238cae))
* **contributing:** convert to `.rst` and move to `docs` subdir ([474f318](474f318))
* **contributing:** create blank template ([3633e8f](3633e8f))
* **contributing:** modify quoted heading to prevent TOC inclusion ([abcb6ef](abcb6ef))
* **contributing:** separate `BREAKING CHANGE` under its own heading ([ee053d7](ee053d7))
* **contributing:** update with sub-headings and `commitlint` details ([ea2c9a4](ea2c9a4))
* **index:** add `CONTRIBUTING` to the `toctree` ([0c98e67](0c98e67))
* **readme:** add Read the Docs build status badge ([f47797d](f47797d))
* **readme:** add suggested improvement to `template.service.clean` ([bf1039c](bf1039c))
* **readme:** convert note into a heading ([5f2d789](5f2d789))
* **readme:** fix typos ([007159a](007159a))
* **readme:** move under `docs` subdir to access in both GitHub and RTD ([c92f674](c92f674))
* **readme:** update heading markers for consistency ([5a2bea8](5a2bea8))
* **rtd:** add basic `docs/conf.py` to allow additional customisation ([18d3924](18d3924))
* **rtd:** add basic `index.rst` to allow RTD to produce docs ([f02139f](f02139f))
* **rtd:** add comment to CSS file for overriding in-use Sphinx theme ([f237364](f237364))
* **rtd:** clean up numerous issues and inconsistencies ([ad5a8b8](ad5a8b8))
* **rtd:** use internal link targets at the top of each `.rst` file ([da09528](da09528))
* **tofs:** add more sub-headings to ease document navigation ([2c5dc21](2c5dc21))
* **tofs:** apply language formatting to source code blocks ([0638413](0638413))
* **tofs:** explain how all parts of the `source` can be customised ([2f82eb5](2f82eb5)), closes [saltstack-formulas#44](https://github.com/myii/template-formula/issues/44)
* **tofs:** improve general use of language ([5105d29](5105d29))
* **tofs:** replace existing `.md` with `.rst` and add to RTD ([fd68168](fd68168))
* **tofs:** update the `files_switch` section for the updated macro ([788f732](788f732))
* **tofs:** use `{%-` for all Jinja statements ([4348df8](4348df8))
* **tofs:** use `literalinclude` of `macros.jinja` instead of code dupe ([3f0071b](3f0071b))
* **tofs:** use table to list authorship ([2f0e20f](2f0e20f))
* **yaml:** os*.yaml map files needs at least an empty dict ([dd99750](dd99750))

### Features

* **authors:** update automatically alongside `semantic-release` ([8000098](8000098))
* **kitchen+travis:** add `opensuse-leap` after resolving issues ([7614a3c](7614a3c))
* **kitchen+travis:** conduct tests on a wider range of platforms ([1348078](1348078))
* **m2r:** use `m2r` to convert automatic `.md` files to `.rst` ([b86ddf4](b86ddf4))
* **pkg:** add `clean` states ([422c7ac](422c7ac))
* **pkg:** use `require` requisite between `pkg` states ([6e7141b](6e7141b)), closes [/github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/jinja.py#L120](https://github.com//github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/jinja.py/issues/L120) [/github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/templates.py#L145](https://github.com//github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/templates.py/issues/L145) [/github.com/saltstack/salt/issues/10838#issuecomment-391718086](https://github.com//github.com/saltstack/salt/issues/10838/issues/issuecomment-391718086)
* **rtd:** provide custom CSS file for overriding in-use Sphinx theme ([24bd338](24bd338))
* **semantic-release:** configure for this formula ([cbcfd75](cbcfd75))
* **toc:** use `markdown-toc` directly to update inline ([a5bae1e](a5bae1e))
* **tofs:** implement backwards-compatible TOFSv2 for configurability ([068a94d](068a94d)), closes [/freenode.logbot.info/saltstack-formulas/20190214#c1995273](https://github.com//freenode.logbot.info/saltstack-formulas/20190214/issues/c1995273) [/freenode.logbot.info/saltstack-formulas/20190214#c1995487](https://github.com//freenode.logbot.info/saltstack-formulas/20190214/issues/c1995487)

### Reverts

* **kitchen+travis:** disable `debian-8` due to `2019.2` bug ([e8f0f7e](e8f0f7e))

### Tests

* **inspec:** update `supports` for all platforms added ([42f93b3](42f93b3))

### BREAKING CHANGES

* **states:** Wholesale state ID changes will break implementations
that are relying on the previous state IDs for requisite purposes.
* **pkg:** Changing the `pkg` directory to `package` will break
implementations that are depending on `pkg` for `include` or `sls`-based
requisite purposes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants