defunctzombie / changelog Goto Github PK

doing changelog --release 1.0.0 is annoying. should just be changelog release 1.0.0

imo you should just add # UNRELEASED to the top after every changelog --release. unnecessary spammage

Sometimes you upgrade directly the package.json version (or some people with good intention make a PR with an updated version).

That would be nice to be able to make a release without specifying a version. Obviously if a tag with the version is already existing, you can throw an error OR you can create a patch release.
You can

• if no version/keyword provided
  • read package.json version
  • if no tag fit the version, you create do your job from this version
  • if a tag already exist, you make bump as a patch
• if version/keyword provided
  • do you job

the keyword idea is #3
I used this in the past using mversion. But I stopped using it because I found myself updating changelog.md with version number by hand before using a automatic bumper for package.json

This issue + #3 + #9 would make me use this tool like yesterday ! If you are open, I can give you a hand.

Anyway thanks for this.

right now it requires package.json. would be nice if .json files aren't required as well as update the version for all .json files present.

kind of like npm version patch n stuff

Due to a bug (feature?) in commander, if you type changelog release foo instead of changelog --release foo, it generates an invalid package.json (with the version field as an array). This appears to be because program.release is an array instead of string when you leave out the dashes.

You should either explicitly disallow that syntax or make it work. (Personally I prefer no dashes for this git-style CLI.)

@defunctzombie Awesome tool! Thanks for building and publishing it!

Are you planning support for annotated git tags and custom tag names?

Would be really cool if one could change the tag name from

git tag v<new version>

to an annotated version

git tag -a "<new version>" -m "<custom><new version>"

I prefer to omit the "v" prefix in front of my tags for example, like:

git tag -a "1.0.0" -m "Release 1.0.0"

Let me know what you think about that and if a PR is appreciated :)

In perl land, changelogs were once chaos. Now it is blasphemy not to adhere to https://metacpan.org/pod/CPAN::Changes::Spec . It would be nice to have something like this in Node.js, and it seems like your porject may be it. I haven't particularly read through your spec here, but thought you may be interested in reading into what CPAN::Changes did for perl (the main difference would be that I think we should use markdown in Node.js, though CPAN::Changes does not use markdown).

I think that script I am using might give you an idea

https://github.com/MoOx/setup/blob/master/bin/npmrelease

It grab the section in changelog that fit the version in package.json to create a annotated github release.

This gives this kind of results (example on the 2 latests releases) https://github.com/cssnext/cssnext/releases)

you don't want all your commits to be added to the change log, but it would be nice to be able to optionally add it to the change log. not sure what the best way to do this is th

We came across this project as we were looking at different approaches to managing and automating our own changelog and release notes for users. Is the changelog file missing from this project on purpose? I did however see the history file.

What the? :)

Join all the forces ( https://github.com/uber/build-changelog )