Commit graph

754 commits

Author SHA1 Message Date
Niels Abspoel
2e89b15f6e
Merge pull request #74 from saltstack-formulas/myii-patch-1
refactor(kitchen): `pillars-from-files` => `pillars_from_files`
2019-03-07 19:53:57 +01:00
Imran Iqbal
4f1fe2d253
Merge pull request #75 from myii/refactor/map-jinja-consistency
style(map): use `-` for each Jinja block
2019-03-07 15:12:44 +00:00
Imran Iqbal
64e383474f
style(map): use - for each Jinja block 2019-03-07 15:11:23 +00:00
Imran Iqbal
7c954a7e47
refactor(kitchen): pillars-from-files => pillars_from_files
* https://github.com/saltstack-formulas/packages-formula/pull/50#discussion_r262769817
  - `pillars-from-files` is deprecated in favor of `pillars_from_files`
2019-03-06 17:52:02 +00:00
Imran Iqbal
b9bc8dc0f6
Merge pull request #73 from myii/feature/prepare-docs-for-RTD
chore(semantic-release): move pre-commit script back to root dir
2019-03-06 00:45:19 +00:00
Imran Iqbal
4601d38289
chore(semantic-release): move pre-commit script back to root dir
* https://freenode.logbot.info/saltstack-formulas/20190305#c2040419
2019-03-06 00:36:41 +00:00
semantic-release-bot
a52523b9f4 chore(release): 1.2.0 [skip ci]
# [1.2.0](https://github.com/saltstack-formulas/template-formula/compare/v1.1.2...v1.2.0) (2019-03-03)

### Features

* **m2r:** use `m2r` to convert automatic `.md` files to `.rst` ([b86ddf4](https://github.com/saltstack-formulas/template-formula/commit/b86ddf4))
2019-03-03 05:22:26 +00:00
Imran Iqbal
ab3bb0e575
Merge pull request #72 from myii/feature/prepare-docs-for-RTD
feat(m2r): use `m2r` to convert automatic `.md` files to `.rst`
2019-03-03 05:09:58 +00:00
Imran Iqbal
f341bdb8ef
chore(semantic-release): move pre-commit script to bin/ subdir 2019-03-03 05:05:13 +00:00
Imran Iqbal
b86ddf4ce7
feat(m2r): use m2r to convert automatic .md files to .rst
* https://github.com/miyakogi/m2r
  - Markdown to reStructuredText converter
2019-03-03 05:04:23 +00:00
semantic-release-bot
1a26fdda06 chore(release): 1.1.2 [skip ci]
## [1.1.2](https://github.com/saltstack-formulas/template-formula/compare/v1.1.1...v1.1.2) (2019-03-03)

### Documentation

* **contributing:** add documentation contribution guidelines ([dff0ee8](https://github.com/saltstack-formulas/template-formula/commit/dff0ee8))
* **rtd:** add comment to CSS file for overriding in-use Sphinx theme ([f237364](https://github.com/saltstack-formulas/template-formula/commit/f237364))
* **rtd:** clean up numerous issues and inconsistencies ([ad5a8b8](https://github.com/saltstack-formulas/template-formula/commit/ad5a8b8))
* **tofs:** use `literalinclude` of `macros.jinja` instead of code dupe ([3f0071b](https://github.com/saltstack-formulas/template-formula/commit/3f0071b))
2019-03-03 00:30:55 +00:00
Imran Iqbal
3a2974585f
Merge pull request #71 from myii/feature/prepare-docs-for-RTD
docs(contributing): add documentation contribution guidelines
2019-03-03 00:15:44 +00:00
Imran Iqbal
ad5a8b84bf
docs(rtd): clean up numerous issues and inconsistencies
* Include:
  - Fix link texts
  - Apply text formatting
  - Split some of the long lines (improved diffs)
  - Remove extra `\ ` appearing after conversion from Markdown
  - Improve ordered (numbered) nested lists
  - Use 3-character indents under RST directives
  - Use Jinja commenting in Jinja examples (not just `#`)
2019-03-03 00:11:35 +00:00
Imran Iqbal
3f0071b72b
docs(tofs): use literalinclude of macros.jinja instead of code dupe 2019-03-02 23:56:21 +00:00
Imran Iqbal
dff0ee8ef8
docs(contributing): add documentation contribution guidelines 2019-03-02 23:56:21 +00:00
Imran Iqbal
f2373641b4
docs(rtd): add comment to CSS file for overriding in-use Sphinx theme 2019-03-02 23:54:44 +00:00
semantic-release-bot
ea1841c08d chore(release): 1.1.1 [skip ci]
## [1.1.1](https://github.com/saltstack-formulas/template-formula/compare/v1.1.0...v1.1.1) (2019-03-01)

### Continuous Integration

* **travis:** remove obsolete `markdown-toc` process ([97fbb60](https://github.com/saltstack-formulas/template-formula/commit/97fbb60))

### Documentation

* **contributing:** add TOC to match all other pages ([7b1a2a9](https://github.com/saltstack-formulas/template-formula/commit/7b1a2a9))
* **readme:** add Read the Docs build status badge ([f47797d](https://github.com/saltstack-formulas/template-formula/commit/f47797d))
* **tofs:** replace existing `.md` with `.rst` and add to RTD ([fd68168](https://github.com/saltstack-formulas/template-formula/commit/fd68168))
* **tofs:** use table to list authorship ([2f0e20f](https://github.com/saltstack-formulas/template-formula/commit/2f0e20f))
2019-03-01 16:53:13 +00:00
Imran Iqbal
97fbb601e9
ci(travis): remove obsolete markdown-toc process 2019-03-01 16:40:02 +00:00
Imran Iqbal
f47797d1fc
docs(readme): add Read the Docs build status badge 2019-03-01 16:32:17 +00:00
Imran Iqbal
9294a97b50
Merge pull request #69 from myii/feature/prepare-docs-for-RTD
docs(tofs): replace existing `.md` with `.rst` and add to RTD
2019-03-01 16:21:24 +00:00
Imran Iqbal
7b1a2a9a14
docs(contributing): add TOC to match all other pages 2019-03-01 16:20:49 +00:00
Imran Iqbal
2f0e20f449
docs(tofs): use table to list authorship 2019-03-01 16:07:27 +00:00
Imran Iqbal
fd68168cce
docs(tofs): replace existing .md with .rst and add to RTD 2019-03-01 16:06:28 +00:00
semantic-release-bot
7abef94232 chore(release): 1.1.0 [skip ci]
# [1.1.0](https://github.com/saltstack-formulas/template-formula/compare/v1.0.1...v1.1.0) (2019-03-01)

### Documentation

* **rtd:** add basic `docs/conf.py` to allow additional customisation ([18d3924](https://github.com/saltstack-formulas/template-formula/commit/18d3924))

### Features

* **rtd:** provide custom CSS file for overriding in-use Sphinx theme ([24bd338](https://github.com/saltstack-formulas/template-formula/commit/24bd338))
2019-03-01 15:30:16 +00:00
Imran Iqbal
64c9e70d6e
Merge pull request #68 from myii/feature/prepare-docs-for-RTD
feat(rtd): provide custom CSS file for overriding in-use Sphinx theme
2019-03-01 15:14:31 +00:00
Imran Iqbal
24bd338334
feat(rtd): provide custom CSS file for overriding in-use Sphinx theme
* `sphinx_rtd_theme` known issue: long lines in tables do not wrap by default
  - https://github.com/rtfd/sphinx_rtd_theme/issues/117
2019-03-01 15:08:58 +00:00
Imran Iqbal
18d3924dcb
docs(rtd): add basic docs/conf.py to allow additional customisation
* Incorporate settings from default `docs/conf.py` used by RTD
2019-03-01 14:57:40 +00:00
semantic-release-bot
eb246a284c chore(release): 1.0.1 [skip ci]
## [1.0.1](https://github.com/saltstack-formulas/template-formula/compare/v1.0.0...v1.0.1) (2019-03-01)

### Continuous Integration

* **travis:** remove unavailable files from `markdown-toc` process ([3148f0d](https://github.com/saltstack-formulas/template-formula/commit/3148f0d))

### Documentation

* **contributing:** convert to `.rst` and move to `docs` subdir ([474f318](https://github.com/saltstack-formulas/template-formula/commit/474f318))
* **index:** add `CONTRIBUTING` to the `toctree` ([0c98e67](https://github.com/saltstack-formulas/template-formula/commit/0c98e67))
* **readme:** move under `docs` subdir to access in both GitHub and RTD ([c92f674](https://github.com/saltstack-formulas/template-formula/commit/c92f674))
* **readme:** update heading markers for consistency ([5a2bea8](https://github.com/saltstack-formulas/template-formula/commit/5a2bea8))
* **rtd:** add basic `index.rst` to allow RTD to produce docs ([f02139f](https://github.com/saltstack-formulas/template-formula/commit/f02139f))
* **rtd:** use internal link targets at the top of each `.rst` file ([da09528](https://github.com/saltstack-formulas/template-formula/commit/da09528))
2019-03-01 05:35:09 +00:00
Imran Iqbal
0e4051187d
Merge pull request #67 from myii/feature/prepare-docs-for-RTD
docs(rtd): use internal link targets at the top of each `.rst` file
2019-03-01 05:22:22 +00:00
Imran Iqbal
3148f0de08
ci(travis): remove unavailable files from markdown-toc process 2019-03-01 05:20:49 +00:00
Imran Iqbal
da095281a8
docs(rtd): use internal link targets at the top of each .rst file
* Convert the existing internal link to use `:ref:` instead
2019-03-01 05:19:10 +00:00
Imran Iqbal
f5b02165f7
Merge pull request #66 from myii/feature/prepare-docs-for-RTD
docs(readme): update heading markers for consistency
2019-03-01 01:13:27 +00:00
Imran Iqbal
0c98e67096
docs(index): add CONTRIBUTING to the toctree 2019-03-01 01:10:06 +00:00
Imran Iqbal
5a2bea8fdd
docs(readme): update heading markers for consistency 2019-03-01 01:10:05 +00:00
Imran Iqbal
9397bdf1e4
Merge pull request #65 from myii/feature/prepare-docs-for-RTD
docs(contributing): convert to `.rst` and move to `docs` subdir
2019-03-01 01:00:59 +00:00
Imran Iqbal
474f318653
docs(contributing): convert to .rst and move to docs subdir
* Update link in `README.rst`
2019-03-01 00:59:37 +00:00
Imran Iqbal
8de7804058
Merge pull request #64 from myii/feature/prepare-docs-for-RTD
docs(rtd): initialise `Read the Docs`
2019-02-28 23:57:51 +00:00
Imran Iqbal
f02139f3ac
docs(rtd): add basic index.rst to allow RTD to produce docs 2019-02-28 23:55:19 +00:00
Imran Iqbal
c92f674469
docs(readme): move under docs subdir to access in both GitHub and RTD 2019-02-28 23:50:06 +00:00
semantic-release-bot
b91d304b93 chore(release): 1.0.0 [skip ci]
# [1.0.0](https://github.com/saltstack-formulas/template-formula/compare/v0.7.6...v1.0.0) (2019-02-28)

### Code Refactoring

* **components:** split components into separate subdirs ([d957055](https://github.com/saltstack-formulas/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/saltstack-formulas/template-formula/commit/4443518))
* **pkg:** change to `package` instead ([2cd82e5](https://github.com/saltstack-formulas/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/saltstack-formulas/template-formula/commit/c21f82b))
* **states:** set state IDs based on a dependable structure ([6690ee6](https://github.com/saltstack-formulas/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/saltstack-formulas/template-formula/commit/a218e91))
* **tpldir:** use `topdir` globally in place of `tpldir` ([2838bc9](https://github.com/saltstack-formulas/template-formula/commit/2838bc9))
* **tplroot:** use `tplroot` instead of `topdir` to match `tpldata` ([b7356b0](https://github.com/saltstack-formulas/template-formula/commit/b7356b0))

### Continuous Integration

* **kitchen:** specify `image` explicitly for each platform ([b25fbdc](https://github.com/saltstack-formulas/template-formula/commit/b25fbdc))
* **kitchen+travis:** use `debian:jessie-backports` as `debian-8` ([1b9d249](https://github.com/saltstack-formulas/template-formula/commit/1b9d249)), closes [#50](https://github.com/saltstack-formulas/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)

### Documentation

* **components:** update for separation of `pkg`, `config` & `service` ([726fcab](https://github.com/saltstack-formulas/template-formula/commit/726fcab))
* **readme:** add suggested improvement to `template.service.clean` ([bf1039c](https://github.com/saltstack-formulas/template-formula/commit/bf1039c))
* **readme:** fix typos ([007159a](https://github.com/saltstack-formulas/template-formula/commit/007159a))

### Features

* **pkg:** add `clean` states ([422c7ac](https://github.com/saltstack-formulas/template-formula/commit/422c7ac))
* **pkg:** use `require` requisite between `pkg` states ([6e7141b](https://github.com/saltstack-formulas/template-formula/commit/6e7141b)), closes [/github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/jinja.py#L120](0c78d7dc89/salt/utils/jinja.py/issues/L120) [/github.com/saltstack/salt/blob/0c78d7dc894058988d171a28a11bd4a9dbf60266/salt/utils/templates.py#L145](0c78d7dc89/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)

### Reverts

* **kitchen+travis:** disable `debian-8` due to `2019.2` bug ([e8f0f7e](https://github.com/saltstack-formulas/template-formula/commit/e8f0f7e))

### 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.
2019-02-28 20:26:33 +00:00
Niels Abspoel
22de380b3d
Merge pull request #48 from myii/PR_separate-formula-components
feat(pkg): separate components, use requisites and add `clean` states
2019-02-28 21:03:04 +01:00
Imran Iqbal
c6fc98f9f9
Merge pull request #63 from myii/chore/use-jessie-backports
ci(kitchen+travis): use `debian:jessie-backports` as `debian-8`
2019-02-28 20:02:35 +00:00
Imran Iqbal
b25fbdc2a5
ci(kitchen): specify image explicitly for each platform 2019-02-28 19:35:50 +00:00
Imran Iqbal
1b9d2493c9
ci(kitchen+travis): use debian:jessie-backports as debian-8
* Close #50.
* https://github.com/saltstack/salt/issues/51808
* https://github.com/saltstack/salt-pack/issues/657#issuecomment-467932962
2019-02-28 19:28:29 +00:00
Imran Iqbal
e8f0f7ee2a
revert(kitchen+travis): disable debian-8 due to 2019.2 bug
This reverts commit 178c7103f3.

Fix is to use `debian:jessie-backports`, to fix in the next commit.
2019-02-28 19:27:30 +00:00
Imran Iqbal
007159ac41
docs(readme): fix typos 2019-02-28 00:49:48 +00:00
Imran Iqbal
6690ee6591
refactor(states): set state IDs based on a dependable structure
* Based on:
  - https://github.com/saltstack-formulas/template-formula/pull/48#discussion_r259953473
  - https://github.com/saltstack-formulas/template-formula/pull/48#discussion_r259956996

Consistent structure using 5 parts to the state ID naming:

* 3 parts from the filename:
  - `template/package/install.sls`
* 2 parts from the state:
  - `pkg.installed`
* In the structure:
  - `<formula>-<subdir1>-<subdir2>-<state1>-<state2>`
* Putting together to get:
  - `template-package-install-pkg-installed`

BREAKING CHANGE: Wholesale state ID changes will break implementations
that are relying on the previous state IDs for requisite purposes.
2019-02-28 00:49:47 +00:00
Imran Iqbal
2cd82e5076
refactor(pkg): change to package instead
* https://github.com/saltstack-formulas/template-formula/pull/48#discussion_r259951123

BREAKING CHANGE: Changing the `pkg` directory to `package` will break
implementations that are depending on `pkg` for `include` or `sls`-based
requisite purposes.
2019-02-28 00:49:47 +00:00
Imran Iqbal
b7356b0d41
refactor(tplroot): use tplroot instead of topdir to match tpldata
* Upstream feature request PR:
  - https://github.com/saltstack/salt/pull/51814
2019-02-28 00:49:47 +00:00
Imran Iqbal
bf1039ca99
docs(readme): add suggested improvement to template.service.clean 2019-02-28 00:48:01 +00:00