Skip to content

Document optional Version root element in spec files #100

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Mehtrick merged 2 commits into from
Mar 4, 2026
Merged

Document optional Version root element in spec files #100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3cfbd35
Initial plan
Copilot Mar 4, 2026
3acf63f
Document optional Version root element in README.md and copilot instr…
Copilot Mar 4, 2026
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
3 changes: 3 additions & 0 deletions .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ src/main/resources/

```yaml
Feature: Description of the feature
Version: "1.0.0"
Reference: "[TICKET-123](https://example.com/TICKET-123)"

Background:
Expand All @@ -85,6 +86,8 @@ Scenarios:
- Other assertion
```

The optional `Version` field specifies the version of the spec. In generated Java it becomes a `@version` Javadoc tag; in generated AsciiDoc it is rendered as `Version: <value>` below the feature title.

The optional `Reference` field links a spec to an external ticket or resource. It accepts plain text or a Markdown link `[text](url)`. In generated Java it becomes a `@see` Javadoc tag; in generated AsciiDoc it is rendered as a hyperlink below the feature title.

## Code Generation Process
Expand Down
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ You will find the typical BDD keywords in it. For more convenience there is a [V
`example.zgr`
```yaml
Feature: Test eines KassenAutomaten
Version: "1.0.0"
Reference: "[TICKET-123](https://example.com/TICKET-123)"
Background:
Given:
Expand Down Expand Up @@ -92,6 +93,10 @@ Scenarios:

```

The optional `Version` field specifies the version of the spec:
- In generated Java: rendered as a `@version` Javadoc tag on the abstract class.
- In generated docs: rendered as `Version: <value>` below the feature title.

The optional `Reference` field links a spec to an external ticket or resource. It accepts plain text or a Markdown link `[text](url)`:
- In generated Java: rendered as a `@see <a href="url">text</a>` Javadoc tag on the abstract class.
- In generated docs: rendered as an AsciiDoc hyperlink (`link:url[text]`) below the feature title.
Expand All @@ -110,6 +115,7 @@ import org.junit.Test;

/**
* Test eines KassenAutomaten
* @version 1.0.0
* @see <a href="https://example.com/TICKET-123">TICKET-123</a> */
public abstract class AbstractTestEinesKassenautomaten extends AbstractTestclass implements TestEinesKassenautomatenInterface {
/**
Expand Down Expand Up @@ -180,6 +186,8 @@ public interface TestEinesKassenautomatenInterface {
= Test Foo
:toc:

Version: 1.0.0

Reference: link:https://example.com/TICKET-123[TICKET-123]

== Background
Expand Down
Loading