Skip to content

feat: Enhance dock-docs with new template sections and testing script - #1

Merged
northcutted merged 5 commits into
mainfrom
feat/custom-template-support
Feb 18, 2026
Merged

northcutted merged 5 commits into
mainfrom
feat/custom-template-support

Conversation

@northcutted

Copy link
Copy Markdown
Owner

Description

  • Added multiple image and comparison sections to dock-docs.yaml for improved documentation generation.
  • Implemented checks for required tools and provided feedback on test results.
  • Added support for custom templates and per-section template overrides.
  • Ensured compatibility with Docker for full image analysis and fallback to Dockerfile-only mode.
  • Introduced a comprehensive test script (test-templates.sh) to validate template functionality, including image analysis and output format checks.

- Added multiple image and comparison sections to dock-docs.yaml for improved documentation generation.
- Introduced a comprehensive test script (test-templates.sh) to validate template functionality, including image analysis and output format checks.
- Implemented checks for required tools and provided feedback on test results.
- Added support for custom templates and per-section template overrides.
- Ensured compatibility with Docker for full image analysis and fallback to Dockerfile-only mode.
@github-actions

github-actions Bot commented Feb 18, 2026 •

Copy link
Copy Markdown
Contributor

📊 Test Coverage Report

Total Coverage: 71.0%

Coverage by Package

Package Coverage
View Detailed Coverage
github.com/northcutted/dock-docs/cmd/root.go:95:			runYAMLMode			0.0%
github.com/northcutted/dock-docs/cmd/root.go:261:			runCLIMode			69.6%
github.com/northcutted/dock-docs/cmd/root.go:351:			Execute				0.0%
github.com/northcutted/dock-docs/cmd/root.go:359:			checkToolStatus			69.2%
github.com/northcutted/dock-docs/cmd/root.go:383:			init				100.0%
github.com/northcutted/dock-docs/cmd/root.go:412:			resolveOutputPath		100.0%
github.com/northcutted/dock-docs/cmd/root.go:425:			resolveSectionOutput		100.0%
github.com/northcutted/dock-docs/cmd/root.go:443:			resolveTemplateSel		100.0%
github.com/northcutted/dock-docs/cmd/root.go:469:			describeTemplate		100.0%
github.com/northcutted/dock-docs/cmd/root.go:480:			handleListTemplates		100.0%
github.com/northcutted/dock-docs/cmd/root.go:495:			handleExportTemplate		85.7%
github.com/northcutted/dock-docs/cmd/root.go:510:			handleValidateTemplate		100.0%
github.com/northcutted/dock-docs/cmd/setup.go:45:			init				100.0%
github.com/northcutted/dock-docs/cmd/setup.go:53:			runSetup			0.0%
github.com/northcutted/dock-docs/cmd/setup.go:86:			printToolStatus			0.0%
github.com/northcutted/dock-docs/cmd/version.go:29:			init				100.0%
github.com/northcutted/dock-docs/main.go:5:				main				0.0%
github.com/northcutted/dock-docs/pkg/analysis/analyzer.go:21:		AnalyzeComparison		95.0%
github.com/northcutted/dock-docs/pkg/analysis/analyzer.go:64:		AnalyzeImage			95.2%
github.com/northcutted/dock-docs/pkg/analysis/analyzer.go:147:		mergeStats			96.6%
github.com/northcutted/dock-docs/pkg/config/config.go:48:		ResolvedImages			100.0%
github.com/northcutted/dock-docs/pkg/config/config.go:67:		Load				100.0%
github.com/northcutted/dock-docs/pkg/config/config.go:92:		ResolveTemplate			100.0%
github.com/northcutted/dock-docs/pkg/injector/injector.go:16:		Inject				100.0%
github.com/northcutted/dock-docs/pkg/installer/installer.go:41:		DefaultInstallDir		75.0%
github.com/northcutted/dock-docs/pkg/installer/installer.go:52:		FindTool			77.8%
github.com/northcutted/dock-docs/pkg/installer/installer.go:70:		Status				71.4%
github.com/northcutted/dock-docs/pkg/installer/installer.go:102:	Install				84.0%
github.com/northcutted/dock-docs/pkg/installer/installer.go:150:	InstallAll			93.8%
github.com/northcutted/dock-docs/pkg/installer/installer.go:181:	latestReleaseTag		85.0%
github.com/northcutted/dock-docs/pkg/installer/installer.go:219:	httpGet				75.0%
github.com/northcutted/dock-docs/pkg/installer/installer.go:246:	extractBinaryFromTarGz		88.9%
github.com/northcutted/dock-docs/pkg/parser/parser.go:24:		FilterByType			100.0%
github.com/northcutted/dock-docs/pkg/parser/parser.go:35:		Parse				96.8%
github.com/northcutted/dock-docs/pkg/parser/parser.go:103:		parseComments			100.0%
github.com/northcutted/dock-docs/pkg/parser/parser.go:168:		stripQuotes			100.0%
github.com/northcutted/dock-docs/pkg/parser/parser.go:176:		parseMultiKV			81.0%
github.com/northcutted/dock-docs/pkg/parser/parser.go:232:		parseExpose			100.0%
github.co```
</details>

…add new emoji tests and output format functions

- Updated `runner_test.go` to improve test structure and add new test cases for parsing runtime inspect and manifest outputs.
- Enhanced syft and grype output parsing tests with additional scenarios and validation.
- Refactored dive output tests to use table-driven tests for better readability and maintainability.
- Introduced new tests for emoji representations in `templates_test.go`.
- Added functions to determine output file extensions and direct write formats with corresponding tests.
@northcutted
northcutted merged commit 0f138e6 into main Feb 18, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant