docs(semantic-release): implement an automated changelog

[baby-gnu]

• We move the documentation under “docs/”.
• Enable travis “release” stage

[daks]

You also need to remove docs/_static/css/custom.css, docs/conf.py, docs/index.rst files.

Can you also copy Gemfile and .gitignore from template-formula if needed?

[myii]

@baby-gnu Thanks for this PR. A few changes requested inline and a few more here:

• Please add bin/kitchen and include the instructions in the README.
• The following files are created automatically so don't need to be added to the PR:
  • docs/AUTHORS.rst
  • docs/CHANGELOG.rst
• Not directly related but noticed during the diff with template-formula:
  • Please add the os_family entry to the FORMULA file.
  • test/integration/default/inspec.yml -- please update to platform-name instead of os-name as outlined in saltstack-formulas/template-formula#141

[myii]

@baby-gnu Another suggestion: you may want to make this a feat commit, since semantic-release is more like a minor bump rather than a patch bump.

[myii]

@baby-gnu When you get around to modifying this, could you please update kitchen+travis to use the new develop images, in the same way as the template-formula? Thanks.

[baby-gnu]

Hello @myii, sorry for the delay I was a little bit busy somewhere else.

When you get around to modifying this, could you please update kitchen+travis to use the new develop images, in the same way as the template-formula? Thanks

I can't do that for now since this formula is not yet compatible with python3.

My plan (#33) is to avoid changing the formula too much before having a clean minimal test infrastructure and the semantic-release setup.

[myii]

I can't do that for now since this formula is not yet compatible with python3.

@baby-gnu No problem, let me know when you're ready to merge this.

[baby-gnu]

No problem, let me know when you're ready to merge this.

@myii I did another pull request for the part specific to test (#44).

This should be ready now.

Regards.

[myii]

@baby-gnu Merged, thanks for your contribution.

Before merging, I added another commit to do with the headings in the main README as well as to add the inspec-based README.

I also toyed with the idea of adding the new amazonlinux pre-salted platforms (py2), so that we could at least run the states across all Salt versions, including develop -- without inspec testing. The benefit to that is at least making sure that the formula's code works on each Salt version. I've left that for now; that's something we can discuss in the future.

Thanks also to @daks and @aboe76 for your reviews.

[aboe76]

@baby-gnu nice work!!! and @myii salt-formulas is looking very nice

[saltstack-formulas-travis]

🎉 This PR is included in version 0.7.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

[myii]

@baby-gnu For your reference, this was one of the passing Travis runs including amazonlinux:

• https://travis-ci.com/saltstack-formulas/libvirt-formula/builds/119201446

[myii]

Thanks @aboe76. I should have something new to share soon, to make it easier to manage our 25+ semantic-release formulas. As new changes are required to be propagated for all of these, it's too difficult to do manually.