Skip to content

Docs: Link to rendered GitHub AsciiDoc for release notes #2117

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.

Sign up for GitHub

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

Open
gaurav219 wants to merge 1 commit into
base: gh-pages
Choose a base branch
from
Open

Docs: Link to rendered GitHub AsciiDoc for release notes #2117

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion hugo.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ params:
hugo_version: 0.148.2
pagefind_version: 1.4.0
latest_version: 2.52.0
latest_relnote_url: https://github.com/git/git/raw/HEAD/Documentation/RelNotes/2.52.0.adoc
latest_relnote_url: https://gitlab.com/git-scm/git/-/blob/v2.52.0/Documentation/RelNotes/2.52.0.adoc
latest_release_date: '2025-11-17'
windows_installer:
installer_x64:
Expand Down
2 changes: 1 addition & 1 deletion layouts/shortcodes/install-header.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<h1>Install</h1>
<div class="version-badge">
Latest version: {{ site.Params.latest_version }}
(<a href="https://github.com/git/git/blob/HEAD/Documentation/RelNotes/{{ site.Params.latest_version }}.adoc">Release Notes</a>)
(<a href="https://gitlab.com/git-scm/git/-/blob/v2.52.0/Documentation/RelNotes/{{ site.Params.latest_version }}.adoc">Release Notes</a>)
Copy link
Member

@dscho dscho Dec 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here, too, the hard-coded v2.52.0 revision would come back to bite you, if merged unchanged.

The natural fix would be to replace it by HEAD.

But a more fundamental question that should immediately come to your mind when you make virtually the same change in two separate places (the href value in install-header.html as well as the latest_relnote_url value in update-git-version.rb): Why is this URL defined in two separate locations? That's redundant.

In this particular instance, the obvious question is: if update-git-version.rb goes out of its way to define a global parameter latest_relnote_url in addition to latest_version, why on Earth is that latest_relnote_url parameter not used here?

Paying attention to such details and acting on them while you develop patches will automatically improve the quality of your work by ten times, I am sure.

Copy link
Author

@gaurav219 gaurav219 Dec 9, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will change it to HEAD. Yes, it did come to my mind that why same value I've to change in three places but didn't go much deeper to understand it in full context.

In this particular instance, the obvious question is: if update-git-version.rb goes out of its way to define a global parameter latest_relnote_url in addition to latest_version, why on Earth is that latest_relnote_url parameter not used here?

As for this, ideally, it should be that latest_relnote_url should be used instead of hardcoding it again, but it could be that latest_relnote_url was added later on and was not changed in all places where we mention the link?

The install-header shortcode was constructing the release notes URL manually using latest_version, even though update-git-version.rb already computes a latest_relnote_url parameter for this exact purpose.

Updating the shortcode to use site.Params.latest_relnote_url will remove the duplicated logic, and keeps the URL definition in a single place, hopefully ensures consistency with future changes to the link format.

Should i go ahead and make the change in install-header.html of using the URL from update-git-version.rb, so we have a single source of truth? So basically, the following line -

(<a href="{{ site.Params.latest_relnote_url }}">Release Notes</a>)

</div>
</div>

Expand Down
4 changes: 2 additions & 2 deletions script/update-git-version.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
config = YAML.load_file("hugo.yml")
config["params"] = {} if config["params"].nil?
config["params"]["latest_version"] = version
config["params"]["latest_relnote_url"] = "https://github.com/git/git/raw/HEAD/Documentation/RelNotes/#{version}.adoc"
config["params"]["latest_relnote_url"] = "https://gitlab.com/git-scm/git/-/blob/v2.52.0/Documentation/RelNotes/#{version}.adoc"
Copy link
Member

@dscho dscho Dec 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will break for later versions: You are hard-coding v2.52.0 as the revision in which to look for the release notes. Naturally, this revision only contains the release notes leading up to that version, and once, say, v2.52.1 or v2.53.0 come out, the updated link will 404 because the v2.52.0 revision won't magically change to include the release notes for those new versions.

You need to either replace v2.52.0 by v#{version} (and understand what that is doing), or do the equivalent from before, i.e. point to https://gitlab.com/git-scm/git/-/blob/HEAD/Documentation/RelNotes/2.52.0.adoc.

Copy link
Author

@gaurav219 gaurav219 Dec 9, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I understand. Thanks for explaining in detail. I will make the changes now.
This might be a dumb questions, but, should i rebase/amend and modify the commit with the new changes?
Or should i just add a new commit to my branch?

Copy link
Member

@dscho dscho Dec 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I much prefer amending to leaving incorrect commits as-are.

config["params"]["latest_release_date"] = date.strftime("%Y-%m-%d")
yaml = YAML.dump(config).gsub(/ *$/, "")
File.write("hugo.yml", yaml)
File.write("hugo.yml", yaml)
Loading