Handle IndexFileNames in Writer

.ci/e2e

@@ -50,7 +50,7 @@ export GITHUB_OAUTH_TOKEN=$TOKEN
 buildWebsite() {
   LOCAL_BUILD=1 "${docforge_repo_path}/.ci/build" >/dev/null 2>&1
   mv "$docforge_bin" /usr/local/bin/docforge
-  "${website_generator_path}/.ci/build"
+  SKIP_VALIDATION=true "${website_generator_path}/.ci/build"
 }
 
 echo "Building current docforge"

.ci/integration-test

@@ -87,12 +87,12 @@ docforge_bin="${docforge_repo_path}/bin/docforge"
 
 echo "Docforge version: $(${docforge_bin} version)"
 
-GIT_OAUTH_TOKEN="github.com=${GITHUB_OAUTH_TOKEN:-$(getGitHubToken github_com)}"
+GIT_OAUTH_TOKEN="${GITHUB_OAUTH_TOKEN:-$(getGitHubToken github_com)}"
 test "$GIT_OAUTH_TOKEN" #fail fast
 
 # Run docforge command with Git handler
 echo "Run ${docforge_bin}"
-${docforge_bin} -f "${int_test_manifest}" -d "${int_test_output_tree_dir}" --hugo --github-oauth-token-map "${GIT_OAUTH_TOKEN}" --github-info-destination ../generated-metadata
+${docforge_bin} -f "${int_test_manifest}" -d "${int_test_output_tree_dir}" --hugo --github-oauth-token-map "github.com=${GIT_OAUTH_TOKEN}" --github-info-destination ../generated-metadata
 
 #Remove untested metadata keys
 removeUntestedKeysFromMetadata "${int_test_expected_metadata_dir}"

cmd/app/flags.go

@@ -68,7 +68,7 @@ func configureFlags(command *cobra.Command) {
 		"Rewrites the relative links of documentation files to root-relative where possible.")
 	_ = vip.BindPFlag("hugo-base-url", command.Flags().Lookup("hugo-base-url"))
 
-	command.Flags().StringSlice("hugo-section-files", []string{"readme.md", "readme", "read.me", "index.md", "index"},
+	command.Flags().StringSlice("hugo-section-files", []string{"readme.md", "README.md"},
 		"When building a Hugo-compliant documentation bundle, files with filename matching one form this list (in that order) will be renamed to _index.md. Only useful with --hugo=true")
 	_ = vip.BindPFlag("hugo-section-files", command.Flags().Lookup("hugo-section-files"))
 

pkg/workers/document/document_worker.go

@@ -91,7 +91,7 @@ func (d *Worker) ProcessNode(ctx context.Context, node *manifest.Node) error {
 		}
 		cnt = bytesBuff.Bytes()
 	}
-	if err := d.writer.Write(node.Name(), node.Path, cnt, node); err != nil {
+	if err := d.writer.Write(node.Name(), node.Path, cnt, node, d.hugo.IndexFileNames); err != nil {
 		return err
 	}
 	return nil

pkg/workers/document/document_worker_test.go

@@ -68,7 +68,7 @@ var _ = Describe("Document resolving", func() {
 			}
 			err := dw.ProcessNode(context.TODO(), node)
 			Expect(err).ToNot(HaveOccurred())
-			name, path, cnt, nodegot := w.WriteArgsForCall(0)
+			name, path, cnt, nodegot, _ := w.WriteArgsForCall(0)
 			Expect(name).To(Equal("node"))
 			Expect(path).To(Equal("one"))
 			target, err := manifests.ReadFile("tests/expected_target.md")
@@ -91,7 +91,7 @@ var _ = Describe("Document resolving", func() {
 			}
 			err := dw.ProcessNode(context.TODO(), node)
 			Expect(err).ToNot(HaveOccurred())
-			name, path, cnt, nodegot := w.WriteArgsForCall(0)
+			name, path, cnt, nodegot, _ := w.WriteArgsForCall(0)
 			Expect(name).To(Equal("node"))
 			Expect(path).To(Equal("one"))
 			target, err := manifests.ReadFile("tests/expected_target.md")

pkg/workers/githubinfo/github_info.go

@@ -66,7 +66,7 @@ func (w *Worker) WriteGithubInfo(ctx context.Context, node *manifest.Node) error
 	}
 	nodePath := node.Path
 	klog.V(6).Infof("writing git info for node %s/%s\n", nodePath, node.Name())
-	if err = w.writer.Write(node.Name(), nodePath, b.Bytes(), node); err != nil {
+	if err = w.writer.Write(node.Name(), nodePath, b.Bytes(), node, nil); err != nil {
 		return err
 	}
 	return nil

pkg/workers/githubinfo/github_info_test.go

@@ -99,7 +99,7 @@ var _ = Describe("Executing WriteGithubInfo", func() {
 		})
 		It("succeeded", func() {
 			Expect(err).NotTo(HaveOccurred())
-			_, _, content, _ := writer.WriteArgsForCall(0)
+			_, _, content, _, _ := writer.WriteArgsForCall(0)
 			Expect(string(content)).To(Equal("repoHost1 source_content\nrepoHost2 multi_source_content\n"))
 		})
 	})
@@ -116,7 +116,7 @@ var _ = Describe("Executing WriteGithubInfo", func() {
 
 	It("succeeded", func() {
 		Expect(err).NotTo(HaveOccurred())
-		name, path, content, node := writer.WriteArgsForCall(0)
+		name, path, content, node, _ := writer.WriteArgsForCall(0)
 		Expect(node).NotTo(BeNil())
 		Expect(node.Name()).To(Equal("README.md"))
 		Expect(node.Source).To(Equal("https://github.com/gardener/docforge/blob/master/README.md"))

pkg/workers/resourcedownloader/resourcedownloader.go

@@ -79,7 +79,7 @@ func (d *ResourceDownloadWorker) download(ctx context.Context, Source string, Ta
 	if err != nil {
 		return err
 	}
-	if err = d.writer.Write(Target, "", blob, nil); err != nil {
+	if err = d.writer.Write(Target, "", blob, nil, nil); err != nil {
 		return err
 	}
 	return nil

pkg/workers/resourcedownloader/resourcedownloader_test.go

@@ -102,7 +102,7 @@ var _ = Describe("Executing Download", func() {
 	It("succeeded", func() {
 		Expect(err).NotTo(HaveOccurred())
 		Expect(writer.WriteCallCount()).To(Equal(1))
-		name, path, content, node := writer.WriteArgsForCall(0)
+		name, path, content, node, _ := writer.WriteArgsForCall(0)
 		Expect(node).To(BeNil())
 		Expect(path).To(Equal(""))
 		Expect(name).To(Equal("fake_target"))

pkg/writers/dryRunWriter.go

@@ -70,7 +70,7 @@ func (d *dryRunWriter) GetWriter(root string) Writer {
 	return _w
 }
 
-func (w *writer) Write(name, path string, docBlob []byte, node *manifest.Node) error {
+func (w *writer) Write(name, path string, docBlob []byte, node *manifest.Node, IndexFileNames []string) error {
 	if len(docBlob) > 0 && node != nil {
 		if !strings.HasSuffix(name, ".md") {
 			name = fmt.Sprintf("%s.md", name)

pkg/writers/fswriter.go

@@ -9,6 +9,7 @@ import (
 	"fmt"
 	"os"
 	"path/filepath"
+	"slices"
 
 	"github.com/gardener/docforge/pkg/manifest"
 	"gopkg.in/yaml.v3"
@@ -21,7 +22,10 @@ type FSWriter struct {
 	Hugo bool
 }
 
-func (f *FSWriter) Write(name, path string, docBlob []byte, node *manifest.Node) error {
+func (f *FSWriter) Write(name, path string, docBlob []byte, node *manifest.Node, IndexFileNames []string) error {
+	if slices.Contains(IndexFileNames, name) {
+		name = "_index.md"
+	}
 	//generate _index.md content
 	if f.Hugo && name == "_index.md" && node != nil && node.Frontmatter != nil && docBlob == nil {
 		buf := bytes.Buffer{}

pkg/writers/fswriter_test.go

@@ -59,7 +59,7 @@ func TestWrite(t *testing.T) {
 				}
 			}()
 
-			err := fs.Write(tc.name, tc.path, tc.docBlob, tc.node)
+			err := fs.Write(tc.name, tc.path, tc.docBlob, tc.node, nil)
 
 			if err != tc.wantErr {
 				t.Errorf("expected err %v != %v", tc.wantErr, err)

pkg/writers/writers.go

@@ -12,5 +12,5 @@ import "github.com/gardener/docforge/pkg/manifest"
 //
 //counterfeiter:generate . Writer
 type Writer interface {
-	Write(name, path string, resourceContent []byte, node *manifest.Node) error
+	Write(name, path string, resourceContent []byte, node *manifest.Node, IndexFileNames []string) error
 }