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

Support initial Changelog if not Tags are present #76

Open
Mazorius opened this issue Jun 15, 2020 · 4 comments · May be fixed by #186
Open

Support initial Changelog if not Tags are present #76

Mazorius opened this issue Jun 15, 2020 · 4 comments · May be fixed by #186
Assignees
@clok
Labels
type: enhancement New enhancement

Comments

@Mazorius
Copy link

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

  • Initialized project with commits that should be included in CHANGELOG.md
  • Run git-chlog --output CHANGELOG.md
  • A CHANGELOG.md is created which contains only a Unreleased area with a list of commits

Actual Behavior

  • Initialized project with commits that should be included in CHANGELOG.md
  • Run git-chlog --output CHANGELOG.md
  • Error occurs: ERROR git-tag does not exist

Steps to Reproduce (including precondition)

  • Create a new git repository
  • Init git-chglog
  • Add commits
  • Run git-chlog --output CHANGELOG.md

Screenshot on This Problem (if possible)

⌚️  Generating changelog ...
 ERROR  git-tag does not exist

Your Environment

  • OS: macOS
  • git-chglog version: 0.9.1
@noly noly mentioned this issue Feb 4, 2021
Merged
@clok clok added the type: enhancement New enhancement label Mar 29, 2021
@clok clok self-assigned this Mar 29, 2021
@clok
Copy link
Collaborator

clok commented Mar 29, 2021

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.

@iedsapala
Copy link

@clok you said you currently work around this. How do you currently work around this?

@Mazorius
Copy link
Author

@iedsapala you can set a --next-tag option like in the following command:

git-chglog --next-tag 'Unreleased' --output CHANGELOG.md

The value inside --next-tag is customizable.

@clok clok mentioned this issue May 20, 2021
Open
@clok
Copy link
Collaborator

clok commented May 20, 2021 •
edited

@iedsapala you can set a --next-tag option like in the following command:

git-chglog --next-tag 'Unreleased' --output CHANGELOG.md

The value inside --next-tag is customizable.

This is a solid workaround. Nice suggestion @Mazorius. This is still on my radar to address. Sorry for the delay.

b01 added a commit to b01/git-chglog that referenced this issue Oct 4, 2021
@b01
feat: Add commits to Unreleased when no tags.
103409b 
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
@b01 b01 linked a pull request Oct 4, 2021 that will close this issue
Open
2 tasks
b01 added a commit to b01/git-chglog that referenced this issue May 3, 2022
@b01
feat: Add Commits to Unreleased
c59129f 
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
b01 added a commit to b01/git-chglog that referenced this issue Jun 19, 2023
@b01
feat: Add commits to Unreleased when no tags.
8cffe68 
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
b01 added a commit to b01/git-chglog that referenced this issue Jun 25, 2023
@b01
feat: Add commits to Unreleased when no tags.
4493683 
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
b01 added a commit to b01/git-chglog that referenced this issue Jun 25, 2023
@b01
feat: Add commits to Unreleased when no tags.
ab1807e 
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
b01 added a commit to b01/git-chglog that referenced this issue Jun 25, 2023
@b01
feat: Add commits to Unreleased when no tags.
5bb5d0f 
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
b01 added a commit to b01/git-chglog that referenced this issue Jun 25, 2023
@b01
feat: Add commits to Unreleased when no tags.
24f5cde 
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
b01 added a commit to b01/git-chglog that referenced this issue Jun 25, 2023
@b01
feat: Add Commits To Unreleased Even When No Tags
642800b 
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
b01 added a commit to b01/git-chglog that referenced this issue Jun 25, 2023
@b01
feat: Add Commits To Unreleased Even When No Tags
f1a6770 
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
b01 added a commit to b01/git-chglog that referenced this issue Jun 25, 2023
@b01
feat: Add Commits To Unreleased Even When No Tags
9986463 
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
b01 added a commit to b01/git-chglog that referenced this issue Jun 26, 2023
@b01
feat: Add Commits To Unreleased Even When No Tags
2c0cd71 
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
b01 added a commit to b01/git-chglog that referenced this issue Jun 26, 2023
@b01
feat: Add Commits To Unreleased Even When No Tags
b8dd67b 
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
b01 added a commit to b01/git-chglog that referenced this issue Jun 26, 2023
@b01
feat: Add Commits To Unreleased Even When No Tags
5479cf5 
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
b01 added a commit to b01/git-chglog that referenced this issue Jun 26, 2023
@b01
feat: Add Commits To Unreleased Even When No Tags
6f83838 
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
b01 added a commit to b01/git-chglog that referenced this issue Jun 26, 2023
@b01
feat: Add Commits To Unreleased Even When No Tags
f7bbae0 
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
b01 added a commit to b01/git-chglog that referenced this issue Jun 26, 2023
@b01
feat: Add Commits To Unreleased Even When No Tags
32ee1c9 
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
b01 added a commit to b01/git-chglog that referenced this issue Jun 27, 2023
@b01
feat: Add Commits To Unreleased Even When No Tags
99432e5 
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
b01 added a commit to b01/git-chglog that referenced this issue Jun 29, 2023
@b01
feat: Add Commits To Unreleased Even When No Tags
175b6f3 
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@clok clok

Labels
type: enhancement New enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: Add commits to Unreleased when no tags. b01/git-chglog
3 participants
@clok @Mazorius @iedsapala