Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 2 commits into from
Apr 26, 2019
Merged

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

merged 2 commits into from
Apr 26, 2019

Conversation

daks
Copy link
Member

@daks daks commented Apr 24, 2019 •
edited by myii
Loading

Implementation of semantic-release on nginx-formula.

WIP for now, until we decide how to number versions.
I propose 1.0 for current code (with nginx and nginx.ng states) and 2.0 to the needed change of nginx.ng to nginx and removal of legacy code.

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?).
  • Use this content as the entry for release v1.0.0 (the one before semantic-release).
  • Update the README with the semantic-release information, including the link to commit message formatting.

@daks
Copy link
Member Author

daks commented Apr 24, 2019

Tests are not enabled, or not active when PR is WIP.
Passed on my repo https://travis-ci.com/daks/nginx-formula/builds/109511689

@myii
Copy link
Member

myii commented Apr 24, 2019

@daks Would it be too much to ask to update the matrix to use the new pre-salted images? Otherwise the CI run takes over 20 minutes.

@myii
Copy link
Member

myii commented Apr 24, 2019

In the comparative spreadsheet across all formulas, we calculated this formula to be v0.55.0. What I like about starting with these numbers is that it gives some info about how much development went in to the formula before semantic-release. v1.0.0 doesn't suggest very much. But I'm not forcing this issue, just suggesting.

myii
myii reviewed Apr 24, 2019
View reviewed changes
FORMULA Outdated
os_family: RedHat, Debian, Suse, Gentoo
version: 201507
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
Copy link
Member

Choose a reason for hiding this comment

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

Both os and os_family in the template-formula were given as a full list that can be selected from. So best to only capture the platforms which definitely work with this formula.

@myii
Copy link
Member

myii commented Apr 24, 2019

Looks good otherwise. Have you tested that the releases are created in your own fork?

@daks
Copy link
Member Author

daks commented Apr 25, 2019

  • Images matrix updated
  • version: do you mean we create a 0.5.5 manually before merging this PR?
  • about FORMULA os list, I have no idea which are compatible, the only thing I can do is keep only tested versions but it's not complete

@myii
Copy link
Member

myii commented Apr 25, 2019 •
edited
Loading

  • Images matrix updated

Excellent work, hopefully it will be much faster now.

  • version: do you mean we create a 0.5.5 manually before merging this PR?

Once you're ready, we'll create a v0.5.5 release to cover the history before semantic-release. Then we'll merge this PR to get it all running. Have you already tested this in your own fork?

  • about FORMULA os list, I have no idea which are compatible, the only thing I can do is keep only tested versions but it's not complete

The best idea is to stick to what we're definite about. We don't want to mislead anybody (or SPM, if we get that working). That may mean leaving the lines how they were before.

@daks
Copy link
Member Author

daks commented Apr 25, 2019

I'll test semantic-release on my fork and keep you informed

@aboe76
Copy link
Member

aboe76 commented Apr 25, 2019

@daks, nice work, I agree with @myii about the versioning, v0.5.5 is about the right way to introduce
and then merge nginx with nginx:ng as a v1.0.0 that way everybody knows that a stable nginx-formula is created.

@daks
Copy link
Member Author

daks commented Apr 26, 2019

semantic-release tested with success https://github.com/daks/nginx-formula/releases.

@daks daks marked this pull request as ready for review April 26, 2019 06:18
@myii myii merged commit 1789cd3 into saltstack-formulas:master Apr 26, 2019
@myii
Copy link
Member

myii commented Apr 26, 2019

@daks Excellent work again, thanks.

@myii
Copy link
Member

myii commented Apr 26, 2019

@daks Just noticed that the WIP commit remained! That will fail at the commitlint stage... but should be able to bypass that in Travis -- not usually recommended!

@saltstack-formulas-travis
Copy link

🎉 This PR is included in version 0.55.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

This was referenced Apr 26, 2019
Closed
Closed
Merged
Open
@myii myii mentioned this pull request May 12, 2019
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@myii myii myii left review comments

@javierbertoli javierbertoli Awaiting requested review from javierbertoli

@aboe76 aboe76 Awaiting requested review from aboe76

Assignees
No one assigned
Labels
released
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@daks @myii @aboe76 @saltstack-formulas-travis