Skip to content

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

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
Merged
myii merged 2 commits into from
Jul 15, 2019
Merged

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

myii merged 2 commits into from
Jul 15, 2019

Conversation

@baby-gnu
Copy link
Contributor

@baby-gnu baby-gnu commented Jun 21, 2019

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

@baby-gnu baby-gnu requested review from aboe76 and myii June 21, 2019 14:39
daks
daks reviewed Jun 24, 2019
View reviewed changes
Copy link
Member

@daks daks left a comment

Choose a reason for hiding this comment

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

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
myii suggested changes Jun 25, 2019
View reviewed changes
Copy link
Contributor

@myii myii left a comment

Choose a reason for hiding this comment

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

@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
Copy link
Contributor

myii commented Jun 25, 2019

@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 myii mentioned this pull request Jun 25, 2019
Open
71 tasks
@myii
Copy link
Contributor

myii commented Jun 28, 2019

@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
Copy link
Contributor Author

baby-gnu commented Jul 12, 2019

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
Copy link
Contributor

myii commented Jul 12, 2019

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 baby-gnu force-pushed the feature/semantic-release branch from 710f9f7 to daa6e97 Compare July 15, 2019 15:34
@baby-gnu
feat(semantic-release): implement an automated changelog
7c81125 
* We move the documentation under “docs/”.
* Enable travis “release” stage
@baby-gnu baby-gnu force-pushed the feature/semantic-release branch from daa6e97 to 7c81125 Compare July 15, 2019 15:36
@baby-gnu
Copy link
Contributor Author

baby-gnu commented Jul 15, 2019

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 myii force-pushed the feature/semantic-release branch from 392db5e to 1210527 Compare July 15, 2019 18:51
@myii myii force-pushed the feature/semantic-release branch from 1210527 to df62ff2 Compare July 15, 2019 18:52
@myii myii merged commit 912542c into saltstack-formulas:master Jul 15, 2019
@myii
Copy link
Contributor

myii commented Jul 15, 2019

@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
Copy link
Contributor

aboe76 commented Jul 15, 2019

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

@saltstack-formulas-travis
Copy link

saltstack-formulas-travis commented Jul 15, 2019

🎉 This PR is included in version 0.7.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

@myii
Copy link
Contributor

myii commented Jul 15, 2019

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

@myii
Copy link
Contributor

myii commented Jul 15, 2019

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.

@baby-gnu baby-gnu deleted the feature/semantic-release branch July 18, 2019 07:38
This was referenced Sep 18, 2019
Merged
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@daks daks daks left review comments

+2 more reviewers

@aboe76 aboe76 aboe76 approved these changes

@myii myii myii approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

released

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@baby-gnu @myii @aboe76 @saltstack-formulas-travis @daks