summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorStefan Haller <stefan@haller-berlin.de>2024-03-19 08:42:08 +0100
committerStefan Haller <stefan@haller-berlin.de>2024-03-22 08:13:59 +0100
commitfa79c927480b5e2ae3c9b17330053245a72d2ee0 (patch)
tree859f67607e2383763c4f0299c0eed789e7527731
parent251bfb6a24f6f70d5db0c443b1d4a92a08e6826c (diff)
Make the links in the status panel point to the current version rather than master
We've seen a lot of issues recently where people complain that lazygit doesn't behave as documented, but that was only because they were running the latest release but were looking at the documentation of master. Make the documentation links in the status panel point to the release that they are using in the hope that this will help a little bit with this problem.
-rw-r--r--pkg/constants/links.go4
-rw-r--r--pkg/gui/controllers/status_controller.go13
2 files changed, 13 insertions, 4 deletions
diff --git a/pkg/constants/links.go b/pkg/constants/links.go
index c1335052b..e9b06cba3 100644
--- a/pkg/constants/links.go
+++ b/pkg/constants/links.go
@@ -28,9 +28,9 @@ var Links = struct {
CustomPagers: "https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Pagers.md",
CustomKeybindings: "https://github.com/jesseduffield/lazygit/blob/master/docs/keybindings/Custom_Keybindings.md",
CustomCommands: "https://github.com/jesseduffield/lazygit/wiki/Custom-Commands-Compendium",
- Keybindings: "https://github.com/jesseduffield/lazygit/blob/master/docs/keybindings",
+ Keybindings: "https://github.com/jesseduffield/lazygit/blob/%s/docs/keybindings",
Undoing: "https://github.com/jesseduffield/lazygit/blob/master/docs/Undoing.md",
- Config: "https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md",
+ Config: "https://github.com/jesseduffield/lazygit/blob/%s/docs/Config.md",
Tutorial: "https://youtu.be/VDXvbHZYeKY",
CustomPatchDemo: "https://github.com/jesseduffield/lazygit#rebase-magic-custom-patches",
},
diff --git a/pkg/gui/controllers/status_controller.go b/pkg/gui/controllers/status_controller.go
index f5672ce64..a1f4c2546 100644
--- a/pkg/gui/controllers/status_controller.go
+++ b/pkg/gui/controllers/status_controller.go
@@ -68,13 +68,22 @@ func (self *StatusController) GetKeybindings(opts types.KeybindingsOpts) []*type
}
func (self *StatusController) GetOnRenderToMain() func() error {
+ versionStr := "master"
+ version, err := types.ParseVersionNumber(self.c.GetConfig().GetVersion())
+ if err == nil {
+ // Don't just take the version string as is, but format it again. This
+ // way it will be correct even if a distribution omits the "v", or the
+ // ".0" at the end.
+ versionStr = fmt.Sprintf("v%d.%d.%d", version.Major, version.Minor, version.Patch)
+ }
+
return func() error {
dashboardString := strings.Join(
[]string{
lazygitTitle(),
"Copyright 2022 Jesse Duffield",
- fmt.Sprintf("Keybindings: %s", constants.Links.Docs.Keybindings),
- fmt.Sprintf("Config Options: %s", constants.Links.Docs.Config),
+ fmt.Sprintf("Keybindings: %s", fmt.Sprintf(constants.Links.Docs.Keybindings, versionStr)),
+ fmt.Sprintf("Config Options: %s", fmt.Sprintf(constants.Links.Docs.Config, versionStr)),
fmt.Sprintf("Tutorial: %s", constants.Links.Docs.Tutorial),
fmt.Sprintf("Raise an Issue: %s", constants.Links.Issues),
fmt.Sprintf("Release Notes: %s", constants.Links.Releases),