Skip to content

Commit 7d1bd2f

Browse files
committed
Update links to use docs.junit.org
(cherry picked from commit 030bfbd)
1 parent b8b1a5b commit 7d1bd2f

File tree

15 files changed

+21
-21
lines changed

15 files changed

+21
-21
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ I hereby agree to the terms of the [JUnit Contributor License Agreement](https:/
1111
### Definition of Done
1212

1313
- [ ] There are no TODOs left in the code
14-
- [ ] Method [preconditions](https://junit.org/junit5/docs/snapshot/api/org.junit.platform.commons/org/junit/platform/commons/util/Preconditions.html) are checked and documented in the method's Javadoc
14+
- [ ] Method [preconditions](https://docs.junit.org/snapshot/api/org.junit.platform.commons/org/junit/platform/commons/util/Preconditions.html) are checked and documented in the method's Javadoc
1515
- [ ] [Coding conventions](https://github.com/junit-team/junit5/blob/HEAD/CONTRIBUTING.md#coding-conventions) (e.g. for logging) have been followed
1616
- [ ] Change is covered by [automated tests](https://github.com/junit-team/junit5/blob/HEAD/CONTRIBUTING.md#tests) including corner cases, errors, and exception handling
1717
- [ ] Public API has [Javadoc](https://github.com/junit-team/junit5/blob/HEAD/CONTRIBUTING.md#javadoc) and [`@API` annotations](https://apiguardian-team.github.io/apiguardian/docs/current/api/org/apiguardian/api/API.html)
18-
- [ ] Change is documented in the [User Guide](https://junit.org/junit5/docs/snapshot/user-guide/) and [Release Notes](https://junit.org/junit5/docs/snapshot/user-guide/#release-notes)
18+
- [ ] Change is documented in the [User Guide](https://docs.junit.org/snapshot/user-guide/) and [Release Notes](https://docs.junit.org/snapshot/user-guide/#release-notes)

.github/workflows/release.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ jobs:
222222
id: pagesDeployment
223223
timeout-minutes: 20
224224
run: |
225-
URL="https://junit.org/junit5/docs/${{ inputs.releaseVersion }}/user-guide/junit-user-guide-${{ inputs.releaseVersion }}.pdf"
225+
URL="https://docs.junit.org/${{ inputs.releaseVersion }}/user-guide/junit-user-guide-${{ inputs.releaseVersion }}.pdf"
226226
./.github/scripts/waitForUrl.sh "$URL"
227227
echo "pdfUrl=$URL" >> "$GITHUB_OUTPUT"
228228
- name: Verify integrity of PDF version of User Guide
@@ -293,7 +293,7 @@ jobs:
293293
tag_name: `r${releaseVersion}`,
294294
name: `JUnit ${releaseVersion}`,
295295
generate_release_notes: true,
296-
body: `JUnit ${jupiterVersion} = Platform ${platformVersion} + Jupiter ${jupiterVersion} + Vintage ${vintageVersion}\n\nSee [Release Notes](https://junit.org/junit5/docs/${releaseVersion}/release-notes/).`,
296+
body: `JUnit ${jupiterVersion} = Platform ${platformVersion} + Jupiter ${jupiterVersion} + Vintage ${vintageVersion}\n\nSee [Release Notes](https://docs.junit.org/${releaseVersion}/release-notes/).`,
297297
prerelease: releaseVersion.includes("-"),
298298
};
299299
console.log(requestBody);

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ See [`ExtensionContext`](junit-jupiter-api/src/main/java/org/junit/jupiter/api/e
153153

154154
The JUnit 5 project uses the `@API` annotation from [API Guardian](https://github.com/apiguardian-team/apiguardian).
155155
Publicly available interfaces, classes, and methods have a defined lifecycle
156-
which is described in detail in the [User Guide](https://junit.org/junit5/docs/current/user-guide/#api-evolution).
156+
which is described in detail in the [User Guide](https://docs.junit.org/current/user-guide/#api-evolution).
157157

158158
That following describes the deprecation process followed for API items.
159159

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -94,14 +94,14 @@ of the JUnit Platform, JUnit Jupiter, and JUnit Vintage.
9494

9595
[Codecov]: https://codecov.io/gh/junit-team/junit5
9696
[CONTRIBUTING.md]: https://github.com/junit-team/junit5/blob/HEAD/CONTRIBUTING.md
97-
[Dependency Metadata]: https://junit.org/junit5/docs/current/user-guide/#dependency-metadata
97+
[Dependency Metadata]: https://docs.junit.org/current/user-guide/#dependency-metadata
9898
[GitHub Discussions]: https://github.com/junit-team/junit5/discussions/categories/q-a
9999
[Gradle toolchains]: https://docs.gradle.org/current/userguide/toolchains.html
100100
[Gradle Wrapper]: https://docs.gradle.org/current/userguide/gradle_wrapper.html#sec:using_wrapper
101101
[JaCoCo]: https://www.eclemma.org/jacoco/
102-
[Javadoc]: https://junit.org/junit5/docs/current/api/
102+
[Javadoc]: https://docs.junit.org/current/api/
103103
[JDK 21]: https://javaalmanac.io/jdk/21/
104-
[Release Notes]: https://junit.org/junit5/docs/current/release-notes/
104+
[Release Notes]: https://docs.junit.org/current/release-notes/
105105
[Samples]: https://github.com/junit-team/junit5-samples
106106
[StackOverflow]: https://stackoverflow.com/questions/tagged/junit5
107-
[User Guide]: https://junit.org/junit5/docs/current/user-guide/
107+
[User Guide]: https://docs.junit.org/current/user-guide/

documentation/documentation.gradle.kts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -386,7 +386,7 @@ tasks {
386386
include("user-guide/index.adoc")
387387
}
388388
copyAllResources()
389-
attributes(mapOf("releaseNotesUrl" to "https://junit.org/junit5/docs/$docsVersion/release-notes/"))
389+
attributes(mapOf("releaseNotesUrl" to "https://docs.junit.org/$docsVersion/release-notes/"))
390390
}
391391

392392
val downloadJavadocElementLists by registering {

documentation/src/docs/asciidoc/link-attributes.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:javadoc-root: link:../api
22
ifdef::backend-pdf[]
3-
:javadoc-root: https://junit.org/junit5/docs/{docs-version}/api
3+
:javadoc-root: https://docs.junit.org/{docs-version}/api
44
endif::[]
55
// Snapshot Repository
66
:snapshot-repo: https://central.sonatype.com/service/rest/repository/browse/maven-snapshots

junit-bom/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ or [Gradle]. Please refer to the [User Guide] for details.
55

66
[Maven]: https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html#Importing_Dependencies
77
[Gradle]: https://docs.gradle.org/current/userguide/platforms.html#sub:bom_import
8-
[User Guide]: https://junit.org/junit5/docs/current/user-guide/#dependency-metadata-junit-bom
8+
[User Guide]: https://docs.junit.org/current/user-guide/#dependency-metadata-junit-bom

junit-platform-console/src/main/java/org/junit/platform/console/options/MainCommand.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
description = "Launches the JUnit Platform for test discovery and execution.", //
3939
footerHeading = "%n", //
4040
footer = "For more information, please refer to the JUnit User Guide at%n" //
41-
+ "@|underline https://junit.org/junit5/docs/${junit.docs.version}/user-guide/|@", //
41+
+ "@|underline https://docs.junit.org/${junit.docs.version}/user-guide/|@", //
4242
scope = CommandLine.ScopeType.INHERIT, //
4343
exitCodeOnInvalidInput = CommandResult.FAILURE, //
4444
exitCodeOnExecutionException = CommandResult.FAILURE, //

junit-platform-console/src/main/java/org/junit/platform/console/options/TestDiscoveryOptionsMixin.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ class TestDiscoveryOptionsMixin {
4242
SelectorOptions selectorOptions;
4343

4444
@ArgGroup(validate = false, order = 3, heading = "%n For more information on selectors including syntax examples, see"
45-
+ "%n @|underline https://junit.org/junit5/docs/${junit.docs.version}/user-guide/#running-tests-discovery-selectors|@"
45+
+ "%n @|underline https://docs.junit.org/${junit.docs.version}/user-guide/#running-tests-discovery-selectors|@"
4646
+ "%n%n@|bold FILTERS|@%n%n")
4747
FilterOptions filterOptions;
4848

junit-platform-launcher/src/main/java/org/junit/platform/launcher/TagFilter.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
* <p>Tag expressions are boolean expressions with the following allowed
3434
* operators: {@code !} (not), {@code &} (and), and {@code |} (or). Parentheses
3535
* can be used to adjust for operator precedence. Please refer to the
36-
* <a href="https://junit.org/junit5/docs/current/user-guide/#running-tests-tag-expressions">JUnit 5 User Guide</a>
36+
* <a href="https://docs.junit.org/current/user-guide/#running-tests-tag-expressions">JUnit 5 User Guide</a>
3737
* for usage examples.
3838
*
3939
* <p>Please note that a tag name is a valid tag expression. Thus, wherever a tag

0 commit comments

Comments
 (0)