docs(semantic-release): implement an automated changelog #139

daks · 2019-04-18T10:06:21Z

I think that all files are present. Please let me know if something is missing.
Also I don't know if there is some configuration to be done on the repo itself.

Updates by @myii and @n-rodriguez, moved from the comment below so that it shows up in the GitHub front-end.

Still a few remaining tasks to complete this properly (put these as issues?):

Merge the Changelog files into one (and maybe fill in more of the history?).
Update states list in documentation.
Use this content as the entry for release v1.0.0 (the one before semantic-release).
Upgrade the CI matrix to use the pre-salted images -- the current run takes over 20 minutes (over 45 minutes of total time).

myii · 2019-04-21T03:04:48Z

Couple of things for now (which are related by release version number):

This will need a FORMULA file added.
Also need to decide the version number to "start" from.
1. According to the spreadsheet, the comparative maturity of this formula is v0.16.0.
2. However, there's already a CHANGELOG, which is indicating v1.1.0 or thereabouts -- there is a big jump in there, though -- and it hasn't been updated for years.

@n-rodriguez I hope you don't mind me requesting that you review this PR. We've already implemented semantic-release on a couple of formulas (mainly the template-formula) and it is working really well. However, it does require specific commit message formatting, so your input will be valuable.

myii · 2019-04-21T03:06:56Z

@n-rodriguez Just to be clear, I'm not expecting you to go through the actual code changes as such, although you're welcome to comment on that as well. The main reason is to request your approval/disapproval regarding implementing semantic-release into this formula.

n-rodriguez · 2019-04-21T23:23:31Z

@n-rodriguez I hope you don't mind me requesting that you review this PR.

no problem 👍

I'm not against the idea of semantic versioning and the semantic-release package.

About the version to start from, I'm not against a "reset' to 1.0.0 : the current changelog is meaningless, the formula is globally stable although it needs more documentation.

Some states are not documented and the pillar.example may need some more examples. I don't know about the tests, but it would worth to check them before we could release a true 1.0.0 version.

n-rodriguez · 2019-04-21T23:26:09Z

About the release process : how does it work?

myii · 2019-04-21T23:29:41Z

@n-rodriguez If you can join the #formulas channel in Slack, I can explain it to you in conversation. Otherwise, you can get the general gist starting from here: https://github.com/saltstack-formulas/template-formula/blob/master/docs/CONTRIBUTING.rst#commit-message-formatting.

myii

At the moment, the points made in this comment above will need to be resolved first. I've also noticed a couple of minor issues, which can be discussed when we start testing this in a separate fork.

daks · 2019-04-23T10:44:52Z

Hi,

about the FORMULA file, isn't it auto-generated by the versioning script? How do we maintain the version number inside?
About the version number to publish, I have no idea what's the best: are actual numbers valid and used? If we don't want to mess with that, create a 2.0 can also be possible. Or a 1.2.

myii · 2019-04-23T12:06:08Z

Just copying this over from our discussion on Slack:

@daks About the FORMULA file, the basic arrangement needs to be provided. Just borrow the one in template-formula and modify accordingly. Only the version number is updated automatically during the release process.
As for the version number to start from, then the spreadsheet suggests v0.1.6. However, the out-of-date Changelog suggests v1.1.0. Just put either for now and we can sort it out when finalising this PR.

daks · 2019-04-23T13:22:05Z

FORMULA file added

myii · 2019-04-23T17:20:44Z

FORMULA

+version: 1.0rc
+release: 1
+minimum_version: 2016.11
+summary: Template formula


Not Template formula.

myii · 2019-04-23T17:21:26Z

docs/CONTRIBUTING.rst

+   BREAKING CHANGE: With the removal of all of the `.sls` files under
+   `template package`, this formula no longer supports the installation of
+   packages.
+


Please remove the whole Documentation section below.

As in, all the way to the end of the file. We're not setting up ReadTheDocs for this yet.

myii · 2019-04-23T17:23:08Z

docs/_static/css/custom.css

@@ -0,0 +1,21 @@
+/*


Please remove this file.

myii · 2019-04-23T17:23:23Z

docs/conf.py

@@ -0,0 +1,173 @@
+# -*- coding: utf-8 -*-


Please remove this file.

myii · 2019-04-23T17:23:44Z

docs/index.rst

@@ -0,0 +1,20 @@
+.. _index:


Please remove this file.

myii · 2019-04-23T17:37:31Z

@daks Thanks for all of your work with this. Great job!

myii · 2019-04-24T06:06:22Z

@daks Merged, finally! The new release should be delivered in the next few minutes...

saltstack-formulas-travis · 2019-04-24T06:26:46Z

🎉 This PR is included in version 1.0.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

daks · 2019-04-24T09:11:01Z

@myii thanks for your assistance

myii · 2019-04-24T09:16:47Z

@daks You're welcome.

(Moved the rest of this comment to the very top comment in order to show the checklist items in the GitHub front-end).

daks marked this pull request as ready for review April 18, 2019 10:16

daks force-pushed the semantic-changelog branch from ed19739 to 6167d1a Compare April 18, 2019 10:19

myii self-assigned this Apr 18, 2019

myii mentioned this pull request Apr 19, 2019

Fix semantic versioning saltstack-formulas/beats-formula#15

Merged

myii requested a review from n-rodriguez April 21, 2019 03:04

n-rodriguez approved these changes Apr 21, 2019

View reviewed changes

aboe76 requested a review from myii April 22, 2019 06:34

myii requested changes Apr 22, 2019

View reviewed changes

daks force-pushed the semantic-changelog branch from 6167d1a to 04cd14a Compare April 23, 2019 12:54

myii reviewed Apr 23, 2019

View reviewed changes

FORMULA Outdated

version: 1.0rc

release: 1

minimum_version: 2016.11

summary: Template formula

Copy link

Member

myii Apr 23, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not Template formula.

myii reviewed Apr 23, 2019

View reviewed changes

docs/_static/css/custom.css Outdated

@@ -0,0 +1,21 @@

/*

Copy link

Member

myii Apr 23, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove this file.

myii reviewed Apr 23, 2019

View reviewed changes

docs/conf.py Outdated

@@ -0,0 +1,173 @@

# -*- coding: utf-8 -*-

Copy link

Member

myii Apr 23, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove this file.

myii reviewed Apr 23, 2019

View reviewed changes

docs/index.rst Outdated

@@ -0,0 +1,20 @@

.. _index:

Copy link

Member

myii Apr 23, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove this file.

daks force-pushed the semantic-changelog branch 3 times, most recently from 78c48e2 to 706f581 Compare April 23, 2019 17:30

myii approved these changes Apr 23, 2019

View reviewed changes

daks changed the title ~~chore: implement an automated changelog and semantic versioning~~ docs(semantic-release): implement an automated changelog Apr 24, 2019

docs(semantic-release): implement an automated changelog

54618f7

daks force-pushed the semantic-changelog branch from 706f581 to 54618f7 Compare April 24, 2019 06:01

myii merged commit 9a97fe9 into saltstack-formulas:master Apr 24, 2019

saltstack-formulas-travis added the released label Apr 24, 2019

myii mentioned this pull request Apr 27, 2019

Establish template-formula as the go-to resource for all formula development saltstack-formulas/template-formula#21

Open

71 tasks

n-rodriguez mentioned this pull request Apr 30, 2019

Implement an automated changelog saltstack-formulas/rkhunter-formula#3

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(semantic-release): implement an automated changelog #139

docs(semantic-release): implement an automated changelog #139

daks commented Apr 18, 2019 •

edited by myii

Loading

myii commented Apr 21, 2019

myii commented Apr 21, 2019 •

edited

Loading

n-rodriguez commented Apr 21, 2019

n-rodriguez commented Apr 21, 2019

myii commented Apr 21, 2019 •

edited

Loading

myii left a comment •

edited

Loading

daks commented Apr 23, 2019

myii commented Apr 23, 2019

daks commented Apr 23, 2019

myii Apr 23, 2019

myii Apr 23, 2019

myii Apr 23, 2019

myii Apr 23, 2019

myii Apr 23, 2019

myii Apr 23, 2019

myii commented Apr 23, 2019

myii commented Apr 24, 2019

saltstack-formulas-travis commented Apr 24, 2019

daks commented Apr 24, 2019

myii commented Apr 24, 2019 •

edited

Loading

docs(semantic-release): implement an automated changelog #139

docs(semantic-release): implement an automated changelog #139

Conversation

daks commented Apr 18, 2019 • edited by myii Loading

myii commented Apr 21, 2019

myii commented Apr 21, 2019 • edited Loading

n-rodriguez commented Apr 21, 2019

n-rodriguez commented Apr 21, 2019

myii commented Apr 21, 2019 • edited Loading

myii left a comment • edited Loading

Choose a reason for hiding this comment

daks commented Apr 23, 2019

myii commented Apr 23, 2019

daks commented Apr 23, 2019

myii Apr 23, 2019

Choose a reason for hiding this comment

myii Apr 23, 2019

Choose a reason for hiding this comment

myii Apr 23, 2019

Choose a reason for hiding this comment

myii Apr 23, 2019

Choose a reason for hiding this comment

myii Apr 23, 2019

Choose a reason for hiding this comment

myii Apr 23, 2019

Choose a reason for hiding this comment

myii commented Apr 23, 2019

myii commented Apr 24, 2019

saltstack-formulas-travis commented Apr 24, 2019

daks commented Apr 24, 2019

myii commented Apr 24, 2019 • edited Loading

daks commented Apr 18, 2019 •

edited by myii

Loading

myii commented Apr 21, 2019 •

edited

Loading

myii commented Apr 21, 2019 •

edited

Loading

myii left a comment •

edited

Loading

myii commented Apr 24, 2019 •

edited

Loading