keep-a-changelog | manipulating CHANGELOG.md files | DevOps library

by phly PHP Version: 2.11.0 License: BSD-2-Clause

X-Ray Key Features Code Snippets Community Discussions(1)Vulnerabilities Install Support

kandi X-RAY | keep-a-changelog Summary

keep-a-changelog is a PHP library typically used in Devops applications. keep-a-changelog has no bugs, it has no vulnerabilities, it has a Permissive License and it has low support. You can download it from GitHub.

Tools for manipulating CHANGELOG.md files in Keep A Changelog format, including tagging and releasing.

Support

Quality

Security

License

Reuse

Support

keep-a-changelog has a low active ecosystem.

It has 170 star(s) with 22 fork(s). There are 6 watchers for this library.

It had no major release in the last 12 months.

There are 5 open issues and 32 have been closed. On average issues are closed in 101 days. There are 2 open pull requests and 0 closed requests.

It has a neutral sentiment in the developer community.

The latest version of keep-a-changelog is 2.11.0

Quality

keep-a-changelog has 0 bugs and 0 code smells.

Security

keep-a-changelog has no vulnerabilities reported, and its dependent libraries have no vulnerabilities reported.

keep-a-changelog code analysis shows 0 unresolved vulnerabilities.

There are 0 security hotspots that need review.

License

keep-a-changelog is licensed under the BSD-2-Clause License. This license is Permissive.

Permissive licenses have the least restrictions, and you can use them in most projects.

Reuse

keep-a-changelog releases are available to install and integrate.

Installation instructions, examples and code snippets are available.

keep-a-changelog saves you 3154 person hours of effort in developing the same functionality from scratch.

It has 6787 lines of code, 541 functions and 175 files.

It has low code complexity. Code complexity directly impacts maintainability of the code.

Top functions reviewed by kandi - BETA

kandi has reviewed keep-a-changelog and discovered the below as its top functions. This is intended to give you an instant insight into keep-a-changelog implemented functionality, and help decide if they suit your requirements.

Find all available versions .
Inject provider options .
Checks if a link is enabled .
Verify a tag .
Check if the provider is incomplete .
Check if the git remote name is available .
Convert an array to ini format .
Merge two arrays recursively .
Processes the default configuration .
Get remote repositories .

Get all kandi verified functions for this library.

keep-a-changelog Key Features

No Key Features are available at this moment for keep-a-changelog.

keep-a-changelog Examples and Code Snippets

No Code Snippets are available at this moment for keep-a-changelog.

Community Discussions

Trending Discussions on keep-a-changelog

GitHub changelog links to commits

QUESTION

GitHub changelog links to commits

Asked 2018-Nov-11 at 19:45

Some projects have a CHANGELOG.md file where each version links to the range of commits that were made for that version. For example, this one. It looks like these links are automatically generated somehow, because the markdown only contains [1.0.0] where the rendered document has a link to https://github.com/olivierlacan/keep-a-changelog/compare/v0.3.0...v1.0.0.

How does that work? I've tried to do something like this on my own project, but the rendered document just said [1.0.0]; no link was generated.

Presumably it has something to do with the tags, which follow a similar pattern (v1.0.0), but when I tried to create similar tags in my project, it still didn't work.

I also could find no reference to this on the GitHub help, or anywhere else for that matter.

Is this indeed an (undocumented?) feature of GitHub? If yes, how does it work? If no, how do these projects do it?

Note, I'm not interested in automatically generating a changelog from commits like this project does. I'm just interested in the mechanics of these hyperlinks.

...

ANSWER

Answered 2018-Nov-11 at 19:45

You need to look beneath the surface of the Markdown, it's a simple trick he done by using the file compare feature to compare tags.

If you look at the RAW file, you should notice at the bottom he added links to each version number that has a compare link assigned to it.

Source https://stackoverflow.com/questions/53251732

Community Discussions, Code Snippets contain sources that include Stack Exchange Network

Vulnerabilities

No vulnerabilities reported

Install keep-a-changelog

Run the following to install this library:.
Alternately, install globally, for use with any repository:.

Support

For any new features, suggestions and bugs create an issue on GitHub. If you have any questions check and ask questions on community page Stack Overflow .

Find more information at: