feat: document generation #946
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Signed-off-by: Ron <[email protected]>
…ips-software/amp-devcontainer into feature/document-generation
Allow for nested requirements, the top level being specified by the Feature name and description and child requirements being specified as Rules with their description.
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR introduces document generation capabilities by extracting requirements from Gherkin feature files and converting them to documentation formats. The implementation includes a Python script to parse feature files and generate SBDL format output, along with GitHub workflow automation.
- Added Python script to convert Gherkin feature files to SBDL format requirements
- Created Jinja2 template for generating requirements documentation
- Integrated document generation into GitHub Actions workflow
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 | Enhanced feature file with structured rules and detailed requirements for compilation scenarios |
| docs/templates/requirements.md.j2 | Jinja2 template for generating requirements documentation from SBDL data |
| docs/support/gherkin-to-sbdl.py | Python script to parse Gherkin features and convert to SBDL format |
| .github/workflows/wc-document-generation.yml | GitHub workflow for automated document generation |
| .github/workflows/wc-build-push-test.yml | Integration of document generation into main build workflow |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Signed-off-by: Ron <[email protected]>
Contributor
✅MegaLinter analysis: Success
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
|
Contributor
📦 Container Size AnalysisNote Comparing 📈 Size Comparison Table
|
Contributor
📦 Container Size AnalysisNote Comparing 📈 Size Comparison Table
|
Contributor
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Co-authored-by: Copilot <[email protected]> Signed-off-by: Ron <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Signed-off-by: Ron <[email protected]>
Contributor
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 17 out of 18 changed files in this pull request and generated 5 comments.
Comments suppressed due to low confidence (1)
.github/workflows/wc-document-generation.yml:1
- The artifact download pattern should be more specific. Use 'documents-*' or the exact artifact name to avoid potential conflicts with other artifacts.
---
github-merge-queue
bot
removed this pull request from the merge queue due to a conflict with the base branch
Signed-off-by: Ron <[email protected]>
|
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
Contributor
Pull Request Report (#946)Static measures
Time related measures
Status check related measures
|
Contributor
|
🎉 Hooray! The changes in this pull request went live with the release of v6.5.0 🎉 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🚀 Hey, I have created a Pull Request
Description of changes
This PR updates the documentation generation by:
✔️ Checklist