-
Notifications
You must be signed in to change notification settings - Fork 238
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
Support initial Changelog if not Tags are present #76
Comments
This is something that I have wanted as well. Every time I spin up a new project, I work around this. I will take a look at putting this in place. |
@clok you said you currently work around this. How do you currently work around this? |
@iedsapala you can set a git-chglog --next-tag 'Unreleased' --output CHANGELOG.md The value inside |
This is a solid workaround. Nice suggestion @Mazorius. This is still on my radar to address. Sorry for the delay. |
This requires you to run `git-chglog --init` again to get an updated CHANGELOG.md file that will work with this new feature. Existing template will still work. resolves git-chglog#76
When there are no tags in the repo history, then allow the unreleased section to be populated. To take advantate of this new feature you'll need a new CHANGELOG.tpl.md, which you can get by running git-chglog with the --init flag in your repo. It should overwrite your existing one. However if you have changes in your config.yaml that you'd like to keep, then you can output the new config somewhere else and copy the CHANGELOG.tpl.md into place. This does not break existing templates and they will still work. resolves git-chglog#76
This requires you to run `git-chglog --init` again to get an updated CHANGELOG.md file that will work with this new feature. Existing template will still work. resolves git-chglog#76
When there are commits but no tags, then insert those commits under the unreleased section of the change log output. This requires get an updated CHANGELOG.md.tpl file. resolves git-chglog#76 BREAKING CHANGE * No longer throw the error "no tags" when: * No tag query entered * There are commits to tag * Requires an update to the changelog template
When there are commits but no tags, then insert those commits under the unreleased section of the change log output. This requires get an updated CHANGELOG.md.tpl file. resolves git-chglog#76 BREAKING CHANGE * No longer throw the error "no tags" when: * No tag query entered * There are commits to tag * Requires an update to the changelog template
When there are commits but no tags, then insert those commits under the unreleased section of the change log output. This requires get an updated CHANGELOG.md.tpl file. resolves git-chglog#76 BREAKING CHANGE * No longer throw the error "no tags" when: * No tag query entered * There are commits to tag * Requires an update to the changelog template
When there are commits but no tags, then insert those commits under the unreleased section of the change log output. This requires get an updated CHANGELOG.md.tpl file. resolves git-chglog#76 BREAKING CHANGE * No longer throw the error "no tags" when: * No tag query entered * There are commits to tag * Requires an update to the changelog template
When there are commits but no tags, then insert those commits under the unreleased section of the change log output. This requires get an updated CHANGELOG.md.tpl file. Includig the template footer to account for the unreleased line there that used .Versions. resolves git-chglog#76 BREAKING CHANGE: * No longer throw the error "no tags" when: * No tag query entered * There are commits to tag * Requires an update to the changelog template
When there are commits but no tags, then insert those commits under the unreleased section of the change log output. This requires get an updated CHANGELOG.md.tpl file. Includig the template footer to account for the unreleased line there that used .Versions. resolves git-chglog#76 BREAKING CHANGE: * No longer throw the error "no tags" when: * No tag query entered * There are commits to tag * Requires an update to the changelog template
When there are commits but no tags, then insert those commits under the unreleased section of the change log output. This requires get an updated CHANGELOG.md.tpl file. Includig the template footer to account for the unreleased line there that used .Versions. resolves git-chglog#76 BREAKING CHANGE: * No longer throw the error "no tags" when: * No tag query entered * There are commits to tag * Requires an update to the changelog template
When there are commits but no tags, then insert those commits under the unreleased section of the change log output. This requires get an updated CHANGELOG.md.tpl file. Includig the template footer to account for the unreleased line there that used .Versions. resolves git-chglog#76 BREAKING CHANGE: * No longer throw the error "no tags" when: * No tag query entered * There are commits to tag * Requires an update to the changelog template
When there are commits but no tags, then insert those commits under the unreleased section of the change log output. This requires get an updated CHANGELOG.md.tpl file. Includig the template footer to account for the unreleased line there that used .Versions. resolves git-chglog#76 BREAKING CHANGE: * No longer throw the error "no tags" when: * No tag query entered * There are commits to tag * Requires an update to the changelog template
When there are commits but no tags, then insert those commits under the unreleased section of the change log output. This requires get an updated CHANGELOG.md.tpl file. Includig the template footer to account for the unreleased line there that used .Versions. resolves git-chglog#76 BREAKING CHANGE: * No longer throw the error "no tags" when: * No tag query entered * There are commits to tag * Requires an update to the changelog template
When there are commits but no tags, then insert those commits under the unreleased section of the change log output. This requires get an updated CHANGELOG.md.tpl file. Includig the template footer to account for the unreleased line there that used .Versions. resolves git-chglog#76 BREAKING CHANGE: * No longer throw the error "no tags" when: * No tag query entered * There are commits to tag * Requires an update to the changelog template
When there are commits but no tags, then insert those commits under the unreleased section of the change log output. This requires get an updated CHANGELOG.md.tpl file. Includig the template footer to account for the unreleased line there that used .Versions. resolves git-chglog#76 BREAKING CHANGE: * No longer throw the error "no tags" when: * No tag query entered * There are commits to tag * Requires an update to the changelog template
When there are commits but no tags, then insert those commits under the unreleased section of the change log output. This requires get an updated CHANGELOG.md.tpl file. Includig the template footer to account for the unreleased line there that used .Versions. resolves git-chglog#76 BREAKING CHANGE: * No longer throw the error "no tags" when: * No tag query entered * There are commits to tag * Requires an update to the changelog template
When there are commits but no tags, then insert those commits under the unreleased section of the change log output. This requires get an updated CHANGELOG.md.tpl file. Includig the template footer to account for the unreleased line there that used .Versions. resolves git-chglog#76 BREAKING CHANGE: * No longer throw the error "no tags" when: * No tag query entered * There are commits to tag * Requires an update to the changelog template
When there are commits but no tags, then insert those commits under the unreleased section of the change log output. This requires get an updated CHANGELOG.md.tpl file. Includig the template footer to account for the unreleased line there that used .Versions. resolves git-chglog#76 BREAKING CHANGE: * No longer throw the error "no tags" when: * No tag query entered * There are commits to tag * Requires an update to the changelog template
When a new project is created, the changelog should also be automatically maintained. This is unfortunately not possible due to the current requirement to have a tag, except via
--next-tag
.Expected Behavior
CHANGELOG.md
git-chlog --output CHANGELOG.md
CHANGELOG.md
is created which contains only aUnreleased
area with a list of commitsActual Behavior
CHANGELOG.md
git-chlog --output CHANGELOG.md
ERROR git-tag does not exist
Steps to Reproduce (including precondition)
git-chlog --output CHANGELOG.md
Screenshot on This Problem (if possible)
Your Environment
The text was updated successfully, but these errors were encountered: