Giter Club home page Giter Club logo

Comments (8)

vaab avatar vaab commented on May 9, 2024

@farcepest has a branch on start/end. Putting the commit refs here for later reference.
farcepest@1fb6438

from gitchangelog.

kminh avatar kminh commented on May 9, 2024

This is indeed a very useful feature to have as I already have existing changlog files.

Also, related to support existing changlog files, it would be nice to be able to customize the way each section is generated, for e.g. I don't use RST section for labels (i.e. New, Fix, Changes), I just want them to be a list and related commits are their list items.

from gitchangelog.

vaab avatar vaab commented on May 9, 2024

Ok, thanks for your feedback, note that sectioning concern is also marked in the missing feature in #21 with some workaround if this can help in the meantime.

from gitchangelog.

vaab avatar vaab commented on May 9, 2024

I've just committed a branch incremental-changelog ( https://github.com/vaab/gitchangelog/tree/incremental-changelog ) that implements incremental generation of changelog. This only implements:

 gitchangelog show REVLIST

Please look at additions in README.rst of the PR for more info. Any feedback (tests on your setup) are welcome.

Many thanks for your interests.

from gitchangelog.

kminh avatar kminh commented on May 9, 2024

Thanks for the update, will test it with my setup. Is it possible to have something like:

gitchangelog show HEAD
or
gitchangelog show HEAD^
gitchangelog show HEAD~1
...

Basically I would like to output the changelog relative to the current HEAD.

Perhaps the command that I would use the most is gitchangelog show HEAD, because I just want the latest (unversioned) changes when I release a new version. Maybe make it the default functionality of gitchangelog, and make gitchangelog show all list everything.

from gitchangelog.

vaab avatar vaab commented on May 9, 2024

Well, unless I've misunderstood, this is already working.
By default, calling:

gitchangelog

is equivalent (for compatibility with legacy) to call:

gitchangelog show

which is equivalent (by design) to call:

gitchangelog show HEAD

Which shows the complete changelog.

You are maybe interested by having only the last changes (since your last tag to HEAD). Which you can do by issuing gitchangelog show <LAST_TAG>..HEAD. There are several issues if I wanted to do it internally:

  • If it is unversionned (untagged), how do I figure the tag number to put as title of the section ?
  • If it is versionned, you might want to add several tags at once, how do I know what is the previous tags ?

As a start, I figured that these question could be answered externally from gitchangelog, if you know how to get the last valid tag with a bash oneliner either by looking in your previous changelog for the last entry that was stored, or through a simple git tag -l with some pipe magic to get your last tag, you can provide this to gitchangelog the easy way now.

I'm open to include a way to figure these out internally now, but it must provide maximum configurability. An option in the taste of subject_process, using some configurable pipelines for the most used variations would probably be the way to go.

from gitchangelog.

kminh avatar kminh commented on May 9, 2024

Sorry what I actually meant was: is there a way to quickly generate a changelog for the latest version (could be the last tag, HEAD or HEAD^ etc.) without specifying the exact tags? I believe that's what most people would want when releasing a new version. So running:

gitchangelog

should be equivalent to running one of the following:

# the latest version is unversioned (not tagged yet)
# get changelog from last stable version up to HEAD
gitchangelog show STABLE...HEAD
# or it is already tagged, get changelog from last previous version to the last stable version
gitchangelog show STABLE^...STABLE

I hope that makes sense, but not sure if doable at all.

from gitchangelog.

vaab avatar vaab commented on May 9, 2024

@kminh: I'll head toward a release of the previous feature, even if I read your last message and I acknowledge it doesn't fullfill all your requirements.

I'll create another issue to track the progress of the last part as I understood it.

  • #61 will be about finding the last version.
  • #39 was already pinpointed to manage the output (and allow inserting directly the result in a file)

from gitchangelog.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.