Skip to content

Commit 7a612f9

Browse files
committed
Link to @API Guardian GitHub repository
1 parent 6f3c3b9 commit 7a612f9

File tree

3 files changed

+14
-11
lines changed

3 files changed

+14
-11
lines changed

documentation/src/docs/asciidoc/api-evolution.adoc

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,13 @@ builders. That made changing JUnit 4 especially difficult and sometimes impossib
99
That's why JUnit 5 introduces a defined lifecycle for all publicly available interfaces,
1010
classes, and methods.
1111

12-
[[api-evolution-annotations]]
13-
=== API Annotations
12+
[[api-evolution-version-and-status]]
13+
=== API Version and Status
1414

1515
Every published artifact has a version number `<major>.<minor>.<patch>`, and all publicly
16-
available interfaces, classes, and methods are annotated with {API}. The annotation's
17-
`status` attribute can be assigned one of the following values:
16+
available interfaces, classes, and methods are annotated with {API} from the
17+
{API_Guardian} project. The annotation's `status` attribute can be assigned one of the
18+
following values.
1819

1920
[cols="20,80"]
2021
|===
@@ -39,8 +40,8 @@ value of lower stability.
3940
[[api-evolution-experimental-apis]]
4041
=== Experimental APIs
4142

42-
The following table lists which APIs are currently marked as _experimental_. Caution
43-
should be taken when relying on such APIs.
43+
The following table lists which APIs are currently designated as _experimental_ (via
44+
`@API(status = EXPERIMENTAL)`). Caution should be taken when relying on such APIs.
4445

4546
|===
4647
| Package Name | Class Name | Type
@@ -80,8 +81,9 @@ should be taken when relying on such APIs.
8081
|===
8182

8283
[[api-evolution-tooling]]
83-
=== Tooling Support
84+
=== @API Tooling Support
8485

85-
The JUnit team plans to provide native tooling support for all JUnit users, extenders,
86-
and tool builders. The tooling support will likely provide a means to check if the JUnit
87-
APIs are being used in accordance with `@API` annotation declarations.
86+
The {API_Guardian} project plans to provide tooling support for publishers and consumers
87+
of APIs annotated with {API}. For example, the tooling support will likely provide a
88+
means to check if JUnit APIs are being used in accordance with `@API` annotation
89+
declarations.

documentation/src/docs/asciidoc/index.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ ifdef::backend-pdf[:imagesdir: {outdir}/{imagesdir}]
7373
:MockitoExtension: {junit5-samples-repo}/tree/{release-branch}/junit5-mockito-extension/src/main/java/com/example/mockito/MockitoExtension.java[MockitoExtension]
7474
//
7575
:API: https://apiguardian-team.github.io/apiguardian/docs/current/api/[@API]
76+
:API_Guardian: https://github.com/apiguardian-team/apiguardian[@API Guardian]
7677
:AssertJ: http://joel-costigliola.github.io/assertj/[AssertJ]
7778
:Gitter: https://gitter.im/junit-team/junit5[Gitter]
7879
:Hamcrest: http://hamcrest.org/JavaHamcrest/[Hamcrest]

documentation/src/docs/asciidoc/release-notes-5.0.0.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ on GitHub.
2121
===== Deprecations and Breaking Changes
2222

2323
* The `@API` annotation has been removed from the `junit-platform-commons` project and
24-
relocated to a new standalone project on GitHub called the _@API Guardian_.
24+
relocated to a new standalone project on GitHub called the {API_Guardian}.
2525
* Tags are no longer permitted to contain any of the following _reserved characters_.
2626
- `,`, `(`, `)`, `&`, `|`, `!`
2727
* The constructor for `FilePosition` has been replaced with a static factory method named

0 commit comments

Comments
 (0)