README.md in hieracles-0.1.5 vs README.md in hieracles-0.1.6
- old
+ new
@@ -6,16 +6,20 @@
[](https://travis-ci.org/Gandi/hieracles)
[](https://codeclimate.com/github/Gandi/hieracles/coverage)
[](https://gemnasium.com/Gandi/hieracles)
[](https://codeclimate.com/github/Gandi/hieracles)
-Hieracles is a command-line tool for analysis and deep examination of [Hiera][hiera] paramaters in a [Puppet][puppet] setup. It's used internally at [Gandi][gandi] and its first incarnation is strongly tied to Gandi puppet architecture. But Hieracles tends to become, in time, a generic Hiera overlay visualisation tool.
+Hieracles is a command-line tool for analysis and deep examination of [Hiera][hiera] parameters in a [Puppet][puppet] setup. It can be used to quickly visualize, from a local puppet (typically on a developers environment), all the Hiera params related to a specific node.
+It's used internally at [Gandi][gandi] and its first incarnation is strongly tied to Gandi puppet architecture. But Hieracles tends to become, in time, a generic Hiera overlay visualization tool.
+
+Have a look at the [Changelog](CHANGELOG.md) for details about the evolution.
+
Prerequisite
---------------
-There are many ways to setup puppet and use hiera. This tool is designed to match a certain kind of setup, including:
+There are many ways to setup puppet and use Hiera. This tool is designed to match a certain kind of setup, including:
- an [external node classifier (ENC)][enc]
- a yaml hiera datastore
- classes that only contains includes and no code
- local availability of a hierafile
@@ -137,22 +141,43 @@
echo 'autoload -U _hc' >> ~/.zshrc
Debian packaging
--------------------
-On a Jessie
- apt-get install gem2deb ruby-coveralls ruby-all-dev ruby-rspec ruby-rspec-expectations
+A debian/ dir is included you can just use `sbuild` in here and it will build the .deb.
-Then build
+For new releases:
- gem2deb -p hieracles hieracles
+- update the debian/changelog file
-and install
+FreeBSD packaging
+--------------------
- dpkg -i hieracles_0.0.6-1_all.deb
+For new releases:
+- update the Makefile with new version number
+- in a FreeBSD jail or machine:
+```
+cd hieracles
+git pull
+cd ports/
+make makesum
+# test the stuff, get that there is no warning or what
+portlint
+make stage
+make check-orphans
+make package
+make install
+make deinstall
+make clean
+cd ..
+shar `find rubygem-hieracles` > rubygem-hieracles.shar
+```
+- on https://bugs.freebsd.org submit the new version
+
+
Todo
--------------
- add json format (done)
- add override information in yaml format (done)
- add a command to search for node according to a filter (done)
@@ -164,10 +189,10 @@
- adapt to puppetdb storage
Authors
-----------
-Hieracles original code is writen by [@mose](https://github.com/mose).
+Hieracles original code is written by [@mose](https://github.com/mose).
License
-----------
Hieracles is available under MIT license. See [LICENSE](./LICENSE) file for more details