Skip to content

docs: add links to changelog #5996

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

Closed
wants to merge 1 commit into from

Conversation

alexandear
Copy link
Member

This PR adds clickable links to "Since golangci-lint vX.X.0" and "Deprecated since vX.X.0" that point to the appropriate version in the Changelog.

If the version is greater than or equal to v1.44.0, the link should be https://golangci-lint.run/docs/product/changelog/#vXXX. Otherwise, use https://golangci-lint.run/docs/product/changelog/. This is because changelog headings for these versions use the format Month Year instead of vX.X.X.

Screenshots

Since golangci-lint v1.46.0:

image

Deprecated since v2.2.0:

image

@ldez
Copy link
Member

ldez commented Aug 12, 2025

I don't see the interest in pointing to the changelog inside linter/formatter page.

@ldez ldez self-requested a review August 12, 2025 13:00
@ldez ldez added area: docs feedback required Requires additional feedback labels Aug 12, 2025
@ldez
Copy link
Member

ldez commented Aug 12, 2025

  1. For "Deprecated": required information is already inside the page (replacement, reason)
  2. For "Since": I don't see the point.

Also, the comparison implementation is bugged.

{{ lt "2/10" "2/2" }} -> true
{{ lt "2/2" "2/10" }} -> false

I implemented an equality because it always works.

In all cases, I think that, at some point, we will remove the v1 elements inside the changelog (because the page is too big and elements related to v1 are useless now).

@ldez ldez added declined and removed feedback required Requires additional feedback labels Aug 12, 2025
@ldez ldez closed this Aug 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants