diff --git a/AUTHORS.md b/AUTHORS.md index edf9d4bb..e97c8678 100644 --- a/AUTHORS.md +++ b/AUTHORS.md @@ -4,7 +4,7 @@ This list is sorted by the number of commits per contributor in _descending_ ord Avatar|Contributor|Contributions :-:|---|:-: -@myii|[@myii](https://github.com/myii)|91 +@myii|[@myii](https://github.com/myii)|97 @aboe76|[@aboe76](https://github.com/aboe76)|18 @javierbertoli|[@javierbertoli](https://github.com/javierbertoli)|8 @gravyboat|[@gravyboat](https://github.com/gravyboat)|6 @@ -24,4 +24,4 @@ Avatar|Contributor|Contributions @babilen5|[@babilen5](https://github.com/babilen5)|1 @GMAzrael|[@GMAzrael](https://github.com/GMAzrael)|1 -###### Auto generated by [gaocegege/maintainer](https://github.com/gaocegege/maintainer) on 2019-03-01 +###### Auto generated by [gaocegege/maintainer](https://github.com/gaocegege/maintainer) on 2019-03-03 diff --git a/CHANGELOG.md b/CHANGELOG.md index 3219aae0..8743e394 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,116 @@ # Changelog +# [1.0.0](https://github.com/myii/template-formula/compare/v0.2.0...v1.0.0) (2019-03-03) + + +### Bug Fixes + +* **pillar:** fix `os_family` typo ([3f89c12](https://github.com/myii/template-formula/commit/3f89c12)) +* **tofs:** update comments in `files_switch` macro for new method ([3fa3640](https://github.com/myii/template-formula/commit/3fa3640)) +* **tofs:** use `tpldir` derivative `topdir` for pillar (config) paths ([5e9df00](https://github.com/myii/template-formula/commit/5e9df00)) + + +### Code Refactoring + +* **components:** split components into separate subdirs ([d957055](https://github.com/myii/template-formula/commit/d957055)), closes [/github.com/saltstack-formulas/template-formula/pull/48#pullrequestreview-207182085](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/pullrequestreview-207182085) [/github.com/saltstack-formulas/template-formula/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](https://github.com/myii/template-formula/commit/4443518)) +* **kitchen:** prefer `kitchen.yml` to `.kitchen.yml` ([3860bf9](https://github.com/myii/template-formula/commit/3860bf9)) +* **macros:** use `tplroot` instead of `topdir` to match `tpldata` ([923b459](https://github.com/myii/template-formula/commit/923b459)) +* **pkg:** change to `package` instead ([2cd82e5](https://github.com/myii/template-formula/commit/2cd82e5)), closes [/github.com/saltstack-formulas/template-formula/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](https://github.com/myii/template-formula/commit/c21f82b)) +* **states:** set state IDs based on a dependable structure ([6690ee6](https://github.com/myii/template-formula/commit/6690ee6)), closes [/github.com/saltstack-formulas/template-formula/pull/48#discussion_r259953473](https://github.com//github.com/saltstack-formulas/template-formula/pull/48/issues/discussion_r259953473) [/github.com/saltstack-formulas/template-formula/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](https://github.com/myii/template-formula/commit/a218e91)) +* **tpldir:** use `topdir` globally in place of `tpldir` ([2838bc9](https://github.com/myii/template-formula/commit/2838bc9)) +* **tpldir:** use `tpldir` or derivatives to make formula portable ([52d03d8](https://github.com/myii/template-formula/commit/52d03d8)), closes [#22](https://github.com/myii/template-formula/issues/22) +* **tplroot:** use `tplroot` instead of `topdir` to match `tpldata` ([b7356b0](https://github.com/myii/template-formula/commit/b7356b0)) + + +### Continuous Integration + +* **kitchen:** check for repos updates before trying package installation ([b632383](https://github.com/myii/template-formula/commit/b632383)) +* **kitchen:** improve comments about `opensuse` problems encountered ([c246939](https://github.com/myii/template-formula/commit/c246939)) +* **kitchen:** specify `image` explicitly for each platform ([b25fbdc](https://github.com/myii/template-formula/commit/b25fbdc)) +* **kitchen:** use `salt-minion` version of `opensuse` to ensure tests run ([99b073a](https://github.com/myii/template-formula/commit/99b073a)) +* **kitchen+travis:** disable `debian-8` due to `2019.2` installation bug ([178c710](https://github.com/myii/template-formula/commit/178c710)) +* **kitchen+travis:** use `debian:jessie-backports` as `debian-8` ([1b9d249](https://github.com/myii/template-formula/commit/1b9d249)), closes [#50](https://github.com/myii/template-formula/issues/50) [/github.com/saltstack/salt-pack/issues/657#issuecomment-467932962](https://github.com//github.com/saltstack/salt-pack/issues/657/issues/issuecomment-467932962) +* **travis:** include `commitlint` stage ([6659a69](https://github.com/myii/template-formula/commit/6659a69)) +* **travis:** prevent `release` stage running for PRs ([3a072c7](https://github.com/myii/template-formula/commit/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/template-formula/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](https://github.com/myii/template-formula/commit/97fbb60)) +* **travis:** remove obsolete check based on `$TRAVIS_TEST_RESULT` ([6df9c95](https://github.com/myii/template-formula/commit/6df9c95)) +* **travis:** remove unavailable files from `markdown-toc` process ([3148f0d](https://github.com/myii/template-formula/commit/3148f0d)) + + +### Documentation + +* **changelog:** add missing entry under `v0.3.2` ([50352b5](https://github.com/myii/template-formula/commit/50352b5)) +* **changelog:** merge previous `rst` into new `md` format ([2b4e485](https://github.com/myii/template-formula/commit/2b4e485)) +* **changelog:** remove erroneous "closes" used by `semantic-release` ([be4571d](https://github.com/myii/template-formula/commit/be4571d)) +* **components:** update for separation of `pkg`, `config` & `service` ([726fcab](https://github.com/myii/template-formula/commit/726fcab)) +* **contributing:** add basic introductory text before the TOC ([45ccaf6](https://github.com/myii/template-formula/commit/45ccaf6)) +* **contributing:** add commit message formatting instructions ([fb3d173](https://github.com/myii/template-formula/commit/fb3d173)) +* **contributing:** add documentation contribution guidelines ([dff0ee8](https://github.com/myii/template-formula/commit/dff0ee8)) +* **contributing:** add TOC to match all other pages ([7b1a2a9](https://github.com/myii/template-formula/commit/7b1a2a9)) +* **contributing:** centre-align version bump columns in table ([a238cae](https://github.com/myii/template-formula/commit/a238cae)) +* **contributing:** convert to `.rst` and move to `docs` subdir ([474f318](https://github.com/myii/template-formula/commit/474f318)) +* **contributing:** create blank template ([3633e8f](https://github.com/myii/template-formula/commit/3633e8f)) +* **contributing:** modify quoted heading to prevent TOC inclusion ([abcb6ef](https://github.com/myii/template-formula/commit/abcb6ef)) +* **contributing:** separate `BREAKING CHANGE` under its own heading ([ee053d7](https://github.com/myii/template-formula/commit/ee053d7)) +* **contributing:** update with sub-headings and `commitlint` details ([ea2c9a4](https://github.com/myii/template-formula/commit/ea2c9a4)) +* **index:** add `CONTRIBUTING` to the `toctree` ([0c98e67](https://github.com/myii/template-formula/commit/0c98e67)) +* **readme:** add Read the Docs build status badge ([f47797d](https://github.com/myii/template-formula/commit/f47797d)) +* **readme:** add suggested improvement to `template.service.clean` ([bf1039c](https://github.com/myii/template-formula/commit/bf1039c)) +* **readme:** convert note into a heading ([5f2d789](https://github.com/myii/template-formula/commit/5f2d789)) +* **readme:** fix typos ([007159a](https://github.com/myii/template-formula/commit/007159a)) +* **readme:** move under `docs` subdir to access in both GitHub and RTD ([c92f674](https://github.com/myii/template-formula/commit/c92f674)) +* **readme:** update heading markers for consistency ([5a2bea8](https://github.com/myii/template-formula/commit/5a2bea8)) +* **rtd:** add basic `docs/conf.py` to allow additional customisation ([18d3924](https://github.com/myii/template-formula/commit/18d3924)) +* **rtd:** add basic `index.rst` to allow RTD to produce docs ([f02139f](https://github.com/myii/template-formula/commit/f02139f)) +* **rtd:** add comment to CSS file for overriding in-use Sphinx theme ([f237364](https://github.com/myii/template-formula/commit/f237364)) +* **rtd:** clean up numerous issues and inconsistencies ([ad5a8b8](https://github.com/myii/template-formula/commit/ad5a8b8)) +* **rtd:** use internal link targets at the top of each `.rst` file ([da09528](https://github.com/myii/template-formula/commit/da09528)) +* **tofs:** add more sub-headings to ease document navigation ([2c5dc21](https://github.com/myii/template-formula/commit/2c5dc21)) +* **tofs:** apply language formatting to source code blocks ([0638413](https://github.com/myii/template-formula/commit/0638413)) +* **tofs:** explain how all parts of the `source` can be customised ([2f82eb5](https://github.com/myii/template-formula/commit/2f82eb5)), closes [#44](https://github.com/myii/template-formula/issues/44) +* **tofs:** improve general use of language ([5105d29](https://github.com/myii/template-formula/commit/5105d29)) +* **tofs:** replace existing `.md` with `.rst` and add to RTD ([fd68168](https://github.com/myii/template-formula/commit/fd68168)) +* **tofs:** update the `files_switch` section for the updated macro ([788f732](https://github.com/myii/template-formula/commit/788f732)) +* **tofs:** use `{%-` for all Jinja statements ([4348df8](https://github.com/myii/template-formula/commit/4348df8)) +* **tofs:** use `literalinclude` of `macros.jinja` instead of code dupe ([3f0071b](https://github.com/myii/template-formula/commit/3f0071b)) +* **tofs:** use table to list authorship ([2f0e20f](https://github.com/myii/template-formula/commit/2f0e20f)) +* **yaml:** os*.yaml map files needs at least an empty dict ([dd99750](https://github.com/myii/template-formula/commit/dd99750)) + + +### Features + +* **authors:** update automatically alongside `semantic-release` ([8000098](https://github.com/myii/template-formula/commit/8000098)) +* **kitchen+travis:** add `opensuse-leap` after resolving issues ([7614a3c](https://github.com/myii/template-formula/commit/7614a3c)) +* **kitchen+travis:** conduct tests on a wider range of platforms ([1348078](https://github.com/myii/template-formula/commit/1348078)) +* **pkg:** add `clean` states ([422c7ac](https://github.com/myii/template-formula/commit/422c7ac)) +* **pkg:** use `require` requisite between `pkg` states ([6e7141b](https://github.com/myii/template-formula/commit/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](https://github.com/myii/template-formula/commit/24bd338)) +* **semantic-release:** configure for this formula ([cbcfd75](https://github.com/myii/template-formula/commit/cbcfd75)) +* **toc:** use `markdown-toc` directly to update inline ([a5bae1e](https://github.com/myii/template-formula/commit/a5bae1e)) +* **tofs:** implement backwards-compatible TOFSv2 for configurability ([068a94d](https://github.com/myii/template-formula/commit/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](https://github.com/myii/template-formula/commit/e8f0f7e)) + + +### Tests + +* **inspec:** update `supports` for all platforms added ([42f93b3](https://github.com/myii/template-formula/commit/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. + ## [1.1.1](https://github.com/saltstack-formulas/template-formula/compare/v1.1.0...v1.1.1) (2019-03-01) diff --git a/FORMULA b/FORMULA index e9cf2481..6f34b471 100644 --- a/FORMULA +++ b/FORMULA @@ -1,7 +1,7 @@ name: template os: Debian, Ubuntu, Raspbian, RedHat, Fedora, CentOS, Suse, openSUSE, Gentoo, Funtoo, Arch, Manjaro, Alpine, FreeBSD, OpenBSD, Solaris, SmartOS, Windows, MacOS os_family: Debian, RedHat, Suse, Gentoo, Arch, Alpine, FreeBSD, OpenBSD, Solaris, Windows, MacOS -version: 1.1.1 +version: 1.0.0 release: 1 minimum_version: 2016.11 summary: Template formula