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.

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

Bump comment tag #174

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Bump comment tag #174

wants to merge 5 commits into from

Conversation

chazzly
Copy link
Contributor

@chazzly chazzly commented Feb 3, 2015

This PR supersedes PR #145.

I had originally separated this to its own branch, but after incorporating the new release, it seemed way easier to submit all as one.

This adds an option to the spork bump plug-in to prompt the user for a comment about their change (the reason for the bump). This comment is appended to CHANGELOG.md, which is then added to git. This comment can also be used as the commit message on a git commit.
Based on suggestion from @TheSerapher, I've added the option to create a git tag of "[cookbook name]-[new version string]"

Future possibilities:

  • Pass comment to various communications plugins (we don't currently use any of these, so may need help here).
  • Pull windows username as well as UNIX "ENV['USER']"

@chazzly
Copy link
Contributor Author

chazzly commented Feb 3, 2015

@jonlives, one thing I don't like, but couldn't figure a better way to handle:

In order for the bump plugin to know to prompt for a comment, I added the config option:
:bump_comment

The only way I could figure out to have the git plugin know that it should pull the comment was to also add the config option:
:git
--- :bump_comment

I really don't like having what is essentially a duplicate option, but i couldn't find another way to do it.
Any suggestions?

@jonlives
Copy link
Owner

jonlives commented Feb 3, 2015

@chazzly thanks for this! I'll try and take a look through the code over the next few days and see what I can suggest re the config flag :)

@chazzly chazzly force-pushed the bump_comment_tag branch from 576e617 to f645594 Compare May 14, 2015 16:45
@chazzly
Copy link
Contributor Author

chazzly commented May 14, 2015

I re-based to master, and removed the bump-commit & bump-tag command line options, as they are not working (they work perfectly if specified in the config file, just not the command line, and bump_comment still works from the command line). I still haven't figured out a way around sharing the config options between "spork_bump.rb" and the git plug-in (Which is why the command line options above don't work). This does everything intended, but having to list "bump_comment" in two places in the config file is a little strange.

Any suggestions?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants