Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
9c51732
Update new package README template
mjwolf Jul 1, 2025
c2323d2
Only create new files in integration packages
mjwolf Jul 1, 2025
65c93b4
Fix whitespace
mjwolf Jul 1, 2025
70e4bfd
Use new template for the test apache package readme
mjwolf Jul 2, 2025
ecf9bed
Merge remote-tracking branch 'upstream/main' into docs-template
mjwolf Jul 2, 2025
89b34ec
Merge remote-tracking branch 'upstream/main' into docs-template
mjwolf Jul 9, 2025
bd327d0
Merge remote-tracking branch 'upstream/main' into docs-template
mjwolf Jul 29, 2025
d901942
Updates for new doc template format
mjwolf Jul 30, 2025
fcef419
automatically prepend generated info to generated files; generate for…
kgeller Jul 31, 2025
d7fd5df
fixing tests
kgeller Jul 31, 2025
031eeaf
formatting
kgeller Jul 31, 2025
962358e
only generate to the _dev folder if not a content type, as they have …
kgeller Jul 31, 2025
e03d736
generated notice to test integrations
kgeller Jul 31, 2025
402120c
missed some generated notices
kgeller Jul 31, 2025
80d6c24
last one hopefully
kgeller Jul 31, 2025
9ebe678
Merge branch 'main' of github.com:elastic/elastic-package into docs-t…
kgeller Aug 1, 2025
4688fad
remove header function from template; fixing test and tweaking the te…
kgeller Aug 1, 2025
3977bc8
updating docs
kgeller Aug 4, 2025
10a490f
Merge branch 'main' of github.com:elastic/elastic-package into docs-t…
kgeller Aug 4, 2025
0e6cc14
updating templated based on impl feedback from ti_abusech
kgeller Aug 4, 2025
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
Prev Previous commit
Next Next commit
automatically prepend generated info to generated files; generate for…
… all package types
  • Loading branch information
kgeller committed Jul 31, 2025
commit fcef4196daa60372a28e6db12103fbb3967a5e8e
8 changes: 4 additions & 4 deletions internal/docs/readme.go
Original file line number Diff line number Diff line change
Expand Up @@ -209,9 +209,6 @@ func renderReadme(fileName, packageRoot, templatePath string, linksMap linkMap)
}
return linksMap.RenderLink(args[0], options)
},
"header": func(args ...string) (string, error) {
return doNotModifyStr, nil
},
}).ParseFiles(templatePath)
if err != nil {
return nil, fmt.Errorf("parsing README template failed (path: %s): %w", templatePath, err)
Expand All @@ -222,7 +219,10 @@ func renderReadme(fileName, packageRoot, templatePath string, linksMap linkMap)
if err != nil {
return nil, fmt.Errorf("executing template failed: %w", err)
}
return rendered.Bytes(), nil

// Prepend the doNotModifyStr to all generated files
result := append([]byte(doNotModifyStr+"\n"), rendered.Bytes()...)
return result, nil
}

func readReadme(fileName, packageRoot string) ([]byte, bool, error) {
Expand Down
10 changes: 4 additions & 6 deletions internal/packages/archetype/package.go
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,10 @@ func createPackageInDir(packageDescriptor PackageDescriptor, cwd string) error {
return fmt.Errorf("can't render package README: %w", err)
}

if packageDescriptor.Manifest.Type == "integration" {
logger.Debugf("Write docs readme to _dev")
err = renderResourceFile(packageDocsReadme, &packageDescriptor, filepath.Join(baseDir, "_dev", "build", "docs", "README.md"))
if err != nil {
return fmt.Errorf("can't render package README in _dev: %w", err)
}
logger.Debugf("Write docs readme to _dev")
err = renderResourceFile(packageDocsReadme, &packageDescriptor, filepath.Join(baseDir, "_dev", "build", "docs", "README.md"))
if err != nil {
return fmt.Errorf("can't render package README in _dev: %w", err)
}

if license := packageDescriptor.Manifest.Source.License; license != "" {
Expand Down
1 change: 0 additions & 1 deletion test/packages/parallel/apache/_dev/build/docs/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
{{ `{{header}}` }}
# Apache Integration for Elastic

## Overview
Expand Down
3 changes: 2 additions & 1 deletion test/packages/parallel/apache/docs/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
{{header}}
<!-- NOTICE: Do not edit this file manually.-->
<!-- This file is automatically generated by Elastic Package -->
# Apache Integration for Elastic

## Overview
Expand Down