Refactor DocsDir to use git root directory (#47614) (#47845)

This fixes packaging errors in cloudbeat: elastic/cloudbeat#3567

Change DocsDir() signature to return (string, error) instead of panicking

(cherry picked from commit e65fa6d)

Co-authored-by: Orestis Floros <[email protected]>

Author: mergify[bot]

dev-tools/mage/common.go

@@ -899,13 +899,12 @@ func IsUpToDate(dst string, sources ...string) bool {
 	return err == nil && !execute
 }
 
-func DocsDir() string {
-	cwd := CWD()
-	// Check if we need to correct ossDir because it's in x-pack.
-	if parentDir := filepath.Base(filepath.Dir(cwd)); parentDir == "x-pack" {
-		return filepath.Join(cwd, "../..", "docs")
+func DocsDir() (string, error) {
+	repoInfo, err := GetProjectRepoInfo()
+	if err != nil {
+		return "", fmt.Errorf("failed to get project repo info: %w", err)
 	}
-	return filepath.Join(cwd, "..", "docs")
+	return filepath.Join(repoInfo.RootDir, "docs"), nil
 }
 
 // OSSBeatDir returns the OSS beat directory. You can pass paths and they will

dev-tools/mage/docs.go

@@ -84,7 +84,12 @@ func (docsBuilder) FieldDocs(fieldsYML string) error {
 		return err
 	}
 
-	outputPath := filepath.Join(DocsDir(), "reference", BeatName)
+	docsDir, err := DocsDir()
+	if err != nil {
+		return err
+	}
+
+	outputPath := filepath.Join(docsDir, "reference", BeatName)
 
 	// TODO: Port this script to Go.
 	log.Println(">> Generating exported-fields.md for", BeatName)

metricbeat/scripts/mage/docs_collector.go

@@ -435,8 +435,12 @@ func gatherData(modules []string) ([]moduleData, error) {
 
 // writeModuleDocs writes the module-level docs
 func writeModuleDocs(modules []moduleData, t *template.Template) error {
+	docsDir, err := mage.DocsDir()
+	if err != nil {
+		return err
+	}
 	for _, mod := range modules {
-		filename := filepath.Join(mage.DocsDir(), "reference", "metricbeat", fmt.Sprintf("metricbeat-module-%s.md", mod.Base))
+		filename := filepath.Join(docsDir, "reference", "metricbeat", fmt.Sprintf("metricbeat-module-%s.md", mod.Base))
 		err := writeTemplate(filename, t.Lookup("moduleDoc.tmpl"), mod)
 		if err != nil {
 			return err
@@ -447,6 +451,10 @@ func writeModuleDocs(modules []moduleData, t *template.Template) error {
 
 // writeMetricsetDocs writes the metricset-level docs
 func writeMetricsetDocs(modules []moduleData, t *template.Template) error {
+	docsDir, err := mage.DocsDir()
+	if err != nil {
+		return err
+	}
 	for _, mod := range modules {
 		for _, metricset := range mod.Metricsets {
 			modData := struct {
@@ -456,7 +464,7 @@ func writeMetricsetDocs(modules []moduleData, t *template.Template) error {
 				mod,
 				metricset,
 			}
-			filename := filepath.Join(mage.DocsDir(), "reference", "metricbeat", fmt.Sprintf("metricbeat-metricset-%s-%s.md", mod.Base, metricset.Title))
+			filename := filepath.Join(docsDir, "reference", "metricbeat", fmt.Sprintf("metricbeat-metricset-%s-%s.md", mod.Base, metricset.Title))
 
 			err := writeTemplate(filename, t.Lookup("metricsetDoc.tmpl"), modData)
 			if err != nil {
@@ -469,14 +477,18 @@ func writeMetricsetDocs(modules []moduleData, t *template.Template) error {
 
 // writeModuleList writes the module linked list
 func writeModuleList(modules []moduleData, t *template.Template) error {
+	docsDir, err := mage.DocsDir()
+	if err != nil {
+		return err
+	}
 	// Turn the map into a sorted list
 	//Normally the glob functions would do this sorting for us,
 	//but because we mix the regular and x-pack dirs we have to sort them again.
 	sort.Slice(modules, func(i, j int) bool {
 		return modules[i].Base < modules[j].Base
 	})
 	//write and execute the template
-	filepath := filepath.Join(mage.DocsDir(), "reference", "metricbeat", "metricbeat-modules.md")
+	filepath := filepath.Join(docsDir, "reference", "metricbeat", "metricbeat-modules.md")
 	return writeTemplate(filepath, t.Lookup("moduleList.tmpl"), modules)
 
 }

winlogbeat/scripts/mage/docs.go

@@ -47,6 +47,11 @@ func moduleDocs() error {
 		return fmt.Errorf("No modules found matching %v", searchPath)
 	}
 
+	docsDir, err := mage.DocsDir()
+	if err != nil {
+		return err
+	}
+
 	// Extract module name from path and copy the file.
 	var names []string
 	for _, f := range files {
@@ -59,12 +64,12 @@ func moduleDocs() error {
 		modulesListTmpl += fmt.Sprintf("* [%s](/reference/winlogbeat/winlogbeat-module-%s.md)\n", strings.Title(name), name)
 
 		// Copy to the docs dirs.
-		dest := filepath.Join(mage.DocsDir(), "reference", "winlogbeat", fmt.Sprintf("winlogbeat-module-%s.md", name))
+		dest := filepath.Join(docsDir, "reference", "winlogbeat", fmt.Sprintf("winlogbeat-module-%s.md", name))
 		if err = mage.Copy(f, mage.CreateDir(dest)); err != nil {
 			return err
 		}
 	}
 
 	fmt.Printf(">> update:moduleDocs: Collecting module documentation for %v.\n", strings.Join(names, ", "))
-	return os.WriteFile(filepath.Join(mage.DocsDir(), "reference", "winlogbeat", "winlogbeat-modules.md"), []byte(modulesListTmpl), 0o644)
+	return os.WriteFile(filepath.Join(docsDir, "reference", "winlogbeat", "winlogbeat-modules.md"), []byte(modulesListTmpl), 0o644)
 }