Skip to content

Commit c70867a

Browse files
committedNov 3, 2022
Add Support Policy to docs
1 parent 0f2fa27 commit c70867a

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed
 

‎docs/index.md

+7
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,12 @@ You should now be able to run `ginkgo version` at the command line and see the G
4848

4949
**Note** you _must_ make sure the version of the `ginkgo` cli you install is the same as the version of Ginkgo in your `go.mod` file.
5050

51+
### Support Policy
52+
53+
Ginkgo adheres to semantic versioning - the intent is for there to be no breaking changes along the `2.m.p` line with new functionality landing as minor releases and bug-fixes landing as patch releases (fixes are never back-ported). We work hard to maintain this policy however exceptions (while rare and typically minor) are possible, especially for brand new/emerging features.
54+
55+
The current version of Ginkgo is guaranteed to be compatible with the currently supported versions of Go that are noted by the Go release policy i.e. N and N-1 major versions.
56+
5157
### Your First Ginkgo Suite
5258

5359
Ginkgo hooks into Go's existing `testing` infrastructure. That means that Ginkgo specs live in `*_test.go` files, just like standard go tests. However, instead of using `func TestX(t *testing.T) {}` to write your tests you use the Ginkgo and Gomega DSLs.
@@ -3144,6 +3150,7 @@ When generating combined reports with: `ginkgo -r --json-report=report.json --ou
31443150
When generating separate reports with: `ginkgo -r --json-report=report.json --output-dir=<dir> --keep-separate-reports` Ginkgo will create the `<dir>` directory (if necessary), and place a report file per package in the directory. These reports will be namespaced with the name of the package: `PACKAGE_NAME_report.json`.
31453151

31463152
### Generating reports programmatically
3153+
31473154
The JSON and JUnit reports described above can be easily generated from the command line - there's no need to make any changes to your suite.
31483155

31493156
Ginkgo's reporting infrastructure does, however, provide several mechanisms for writing custom reporting code in your spec suites (or, in a supporting package). We'll explore these mechanisms next.

0 commit comments

Comments
 (0)
Please sign in to comment.