Fix links in release doc so they point to the repo with the right tag (#161)

Author: spring1843

.github/cmd/pkg/cmd/export_md.go

@@ -27,22 +27,32 @@ var exportMDCommand = &cobra.Command{
 			"complexity.md",
 		}
 
+		conf := &problems.ParseConf{
+			Dir:                    dir,
+			ReplacePackageWithMain: cmd.Flag(replacePackageWithMainFlag).Value.String() == "true",
+			ReplaceWithLiveLinks:   cmd.Flag(replaceWithLiveLinksFlag).Value.String() == "true",
+			Version:                cmd.Flag(versionFlag).Value.String(),
+		}
+
 		for _, file := range nonSectionMDFiles {
 			content, err := os.ReadFile(filepath.Join(dir, file))
 			if err != nil {
 				log.Fatalf("Error reading file: %s", err)
 			}
-			fmt.Println(string(content))
+
+			contentStr := string(content)
+
+			if conf.ReplaceWithLiveLinks {
+				contentStr = problems.ReplaceWithLiveLinks(contentStr, "", conf)
+			}
+
+			fmt.Println(string(contentStr))
 		}
 
 		for _, section := range problems.OrderedSections {
-			parsedSection, err := problems.ParseSection(&problems.ParseConf{
-				Dir:                    dir,
-				Section:                section,
-				ReplacePackageWithMain: cmd.Flag(replacePackageWithMainFlag).Value.String() == "true",
-				ReplaceWithLiveLinks:   cmd.Flag(replaceWithLiveLinksFlag).Value.String() == "true",
-				Version:                cmd.Flag(versionFlag).Value.String(),
-			})
+			conf.Section = section
+
+			parsedSection, err := problems.ParseSection(conf)
 			if err != nil {
 				log.Fatalf("Error parsing section: %s", err)
 			}

.github/cmd/pkg/problems/parse.go

@@ -7,6 +7,7 @@ import (
 	"os"
 	"path/filepath"
 	"regexp"
+	"strings"
 )
 
 type ParseConf struct {
@@ -17,6 +18,11 @@ type ParseConf struct {
 	Version                string
 }
 
+const (
+	repoAddress = "https://github.com/spring1843/go-dsa/tree/"
+	mainBranch  = "main"
+)
+
 var rehearsalRegex = regexp.MustCompile(`(?s)(## Rehearsal\n.*?)(\n##|\z)`)
 
 func ParseSection(conf *ParseConf) (string, error) {
@@ -30,6 +36,10 @@ func ParseSection(conf *ParseConf) (string, error) {
 		return "", fmt.Errorf("error replacing the rehearsal section in file: %w", err)
 	}
 
+	if conf.ReplaceWithLiveLinks {
+		preparedContent = ReplaceWithLiveLinks(preparedContent, conf.Section, conf)
+	}
+
 	return preparedContent, nil
 }
 
@@ -50,3 +60,18 @@ func replaceRehearsal(input string, conf *ParseConf) (string, error) {
 	replacement := fmt.Sprintf("## Rehearsal\n%s", stringRehearsalEntries(conf, newRehearsals))
 	return rehearsalRegex.ReplaceAllString(input, replacement), nil
 }
+
+// ReplaceWithLiveLinks replaces the relative links in the input with links to the repo that work.
+func ReplaceWithLiveLinks(input, section string, conf *ParseConf) string {
+	repoBase := repoAddress + conf.Version
+	if conf.Version == "" {
+		repoBase = repoAddress + mainBranch
+	}
+
+	output := input
+	if section != "" {
+		output = strings.ReplaceAll(output, "](../", "]("+repoBase+"/")
+	}
+
+	return strings.ReplaceAll(output, "](./", "]("+repoBase+"/")
+}

.github/workflows/release.yaml

@@ -15,7 +15,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-go@v5
-      - run: make build
+      - run: make build VERSION=${{ github.ref }}
       - name: Create Release
         id: create_release
         uses: actions/create-release@v1

Makefile

@@ -2,7 +2,7 @@ all: build
 
 build:
 	mkdir -p ./bin
-	go run ./.github/cmd/main.go export-md > ./bin/go-dsa.md
+	go run "./.github/cmd/main.go" "export-md" "--version=$(VERSION)" > "./bin/go-dsa.md"
 
 test:
 	go test --race -v -coverprofile=profile.cov ./...