feat: add document generation #841
Conversation
✅
|
| Descriptor | Linter | Files | Fixed | Errors | Warnings | Elapsed time |
|---|---|---|---|---|---|---|
| ✅ ACTION | actionlint | 20 | 0 | 0 | 0.61s | |
| ✅ DOCKERFILE | hadolint | 2 | 0 | 0 | 0.78s | |
| ✅ GHERKIN | gherkin-lint | 2 | 0 | 0 | 1.1s | |
| ✅ JSON | npm-package-json-lint | yes | no | no | 0.46s | |
| ✅ JSON | prettier | 15 | 2 | 0 | 0 | 0.48s |
| ✅ JSON | v8r | 15 | 0 | 0 | 7.24s | |
| ✅ MARKDOWN | markdownlint | 10 | 0 | 0 | 0 | 0.93s |
| ✅ MARKDOWN | markdown-table-formatter | 10 | 0 | 0 | 0 | 0.22s |
| ✅ REPOSITORY | gitleaks | yes | no | no | 0.82s | |
| ✅ REPOSITORY | git_diff | yes | no | no | 0.02s | |
| grype | yes | no | 1 | 27.66s | ||
| ✅ REPOSITORY | secretlint | yes | no | no | 0.99s | |
| ✅ REPOSITORY | syft | yes | no | no | 1.94s | |
| ✅ REPOSITORY | trivy | yes | no | no | 7.05s | |
| ✅ REPOSITORY | trivy-sbom | yes | no | no | 0.25s | |
| ✅ REPOSITORY | trufflehog | yes | no | no | 3.79s | |
| ✅ SPELL | lychee | 64 | 0 | 0 | 21.36s | |
| ✅ YAML | prettier | 26 | 0 | 0 | 0 | 0.91s |
| ✅ YAML | v8r | 26 | 0 | 0 | 8.27s | |
| ✅ YAML | yamllint | 26 | 0 | 0 | 0.95s |
Detailed Issues
⚠️ REPOSITORY / grype - 1 warning
warning: A medium vulnerability in python package: urllib3, version 1.26.20 was found at: /.devcontainer/cpp/requirements.txt
warning: 1 warnings emitted
See detailed reports in MegaLinter artifacts
Your project could benefit from a custom flavor, which would allow you to run only the linters you need, and thus improve runtime performances. (Skip this info by defining FLAVOR_SUGGESTIONS: false)
- Documentation: Custom Flavors
- Command:
npx [email protected] --custom-flavor-setup --custom-flavor-linters ACTION_ACTIONLINT,DOCKERFILE_HADOLINT,GHERKIN_GHERKIN_LINT,JSON_V8R,JSON_PRETTIER,JSON_NPM_PACKAGE_JSON_LINT,MARKDOWN_MARKDOWNLINT,MARKDOWN_MARKDOWN_TABLE_FORMATTER,REPOSITORY_GIT_DIFF,REPOSITORY_GITLEAKS,REPOSITORY_GRYPE,REPOSITORY_SECRETLINT,REPOSITORY_SYFT,REPOSITORY_TRIVY,REPOSITORY_TRIVY_SBOM,REPOSITORY_TRUFFLEHOG,SPELL_LYCHEE,YAML_PRETTIER,YAML_YAMLLINT,YAML_V8R
📦 Container Size AnalysisNote Comparing 📈 Size Comparison Table
|
📦 Container Size AnalysisNote Comparing 📈 Size Comparison Table
|
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Signed-off-by: Ron <[email protected]>
There was a problem hiding this comment.
Pull Request Overview
This PR adds preliminary document generation functionality to amp-devcontainer, using Gherkin feature files to describe requirements that are converted to SBDL format and rendered as PDF documents.
- Restructures existing Gherkin feature files to use Rules format for better requirement specification
- Adds Python script to extract rules from Gherkin files and convert them to CSV/SBDL format
- Implements GitHub Actions workflow for automated document generation with PDF output
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| test/cpp/features/compilation.feature | Restructured to use Gherkin Rules format with detailed compilation requirements |
| docs/templates/requirements.template.md | Added Markdown template for rendering requirements document from SBDL data |
| docs/support/gherkin-to-csv.py | Python script to parse Gherkin files and extract rules to CSV format |
| .github/workflows/wc-document-generation.yml | New workflow for automated document generation using pandoc and LaTeX |
| .github/workflows/wc-build-push-test.yml | Integration of document generation workflow into main build process |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
Pull Request Report (#841)Static measures
Time related measures
Status check related measures
|
|
🎉 Hooray! The changes in this pull request went live with the release of v6.5.0 🎉 |
🚀 Hey, I have created a Pull Request
Description of changes
This PR adds preliminary, and very simple, document generation to amp-devcontainer.
It uses Gherkin feature files to describe requirements as
Rulesfor a ground-truth that is close to the source-code and can be amended byScenarios orExamples for test automation.The feature files are converted to an intermediate format called SBDL and rendered, using a template document, to a PDF.
✔️ Checklist