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.

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

fix should add version links #23

Open
koppor opened this issue Mar 11, 2024 · 2 comments
Open

fix should add version links #23

koppor opened this issue Mar 11, 2024 · 2 comments

Comments

@koppor
Copy link

koppor commented Mar 11, 2024

I executed

changelog fix "Fixed ..."

The diff was

 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+### Fixed
+
+- Fixed ...
+
 ## 1.0.0 - 2021-04-18
 
 Initial public release

There should have been following addition at the end:

+[Unreleased]: https://github.com/koppor/cpdfsqueeze-action/compare/1.0.0...main

The tool should use git to find out the GitHub URL for origin and then "magically" create the URL for the link.


Similar for changelog release. The link for the diff could be generated out of previous links.

@koppor koppor changed the title fix should add the [Unreleased] link fix should add version links Mar 11, 2024
@NiclasvanEyk
Copy link
Owner

That's a nice idea. I also like how Tailwind does it, where they make the version number a link to the diff.

However this generates lots of noise when viewing the changeling in the terminal, which I don't really like. So maybe this can be inferred from the existing releases or a global configuration option as a fallback.

@koppor
Copy link
Author

koppor commented Mar 19, 2024

However this generates lots of noise when viewing the changeling in the terminal, which I don't really like.

Agree.

So maybe this can be inferred from the existing releases or a global configuration option as a fallback.

Unfortunately, current Markdown handlers are not capable of inferring URLs from other links.

Meaning, if a Markdown parser finds

[1.1.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v1.0.0...v1.1.0

It does not know that 1.1.1 is the link olivierlacan/keep-a-changelog@v1.1.0...v1.1.1.

In addition, the "Keep a Changelog" format also has these links: https://github.com/olivierlacan/keep-a-changelog/blob/d1bdf1fa6ad943d5eb66259609323a9c95516780/CHANGELOG.md?plain=1#L250

(And just having [] surrounding a version number makes the impression of broken Markdown links than a cool syntax. At least for me).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants