Code Monkey home page Code Monkey logo

Comments (7)

cburgdorf avatar cburgdorf commented on August 16, 2024

Let's just use the SHA as the version number if no version number is specified. I think we don't need the branch name especially as multiple branch names might point to the same SHA. Just having the SHA + date should be enough information for the case that the version number is omitted.

I wouldn't like the version number to become mandatory because people might just want to have a changelog even if they don't do versioning. In that case, auto versioning with the SHA sounds like a great default to me. Are you ok with that?

And yes the empty, unclosed <a> tag is definitely a bug.

Btw, I could give you push access to this repository if you like?

from clog-cli.

cburgdorf avatar cburgdorf commented on August 16, 2024

Mmh, I took a look at the original project and it's unclear to me what is the point of the <a> tag.

https://github.com/ajoslin/conventional-changelog/blob/master/lib/writer.js#L81

As it stands the <a> tag is only used if no repository link is specified and even then it's not using a href at all (maybe only used as an internal anchor). So, I'm not sure what was the intended purpose and maybe @ajoslin can clarify.

We could certainly use an <a> tag to point to the tag on github if we want to. I think until we decide on that I'll just remove it and use the SHA as the version number if no version number is specified.

from clog-cli.

ajoslin avatar ajoslin commented on August 16, 2024

The purpose of the anchor tag is to make the header on the page linkable.

from clog-cli.

cburgdorf avatar cburgdorf commented on August 16, 2024

Ok, but why only if the repository is NOT specified.

https://github.com/ajoslin/conventional-changelog/blob/master/lib/writer.js#L98

from clog-cli.

cburgdorf avatar cburgdorf commented on August 16, 2024

Because I think the templates may be twisted. The LINK_HEADER_TPL doesn't actually use the link.

https://github.com/ajoslin/conventional-changelog/blob/master/lib/writer.js#L80

from clog-cli.

ajoslin avatar ajoslin commented on August 16, 2024

You're right. This is something I forgot to remove when I took out a link feature.

I'm out right now, would you mind opening an issue about this on the repo?

"link header tpl is deprecated"

from clog-cli.

cburgdorf avatar cburgdorf commented on August 16, 2024

Sure :) conventional-changelog/conventional-changelog#26

from clog-cli.

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.