Adjust docs and release process to renamed example projects

(cherry picked from commit 70640db)

Author: marcphilipp

.github/workflows/release.yml

@@ -77,35 +77,35 @@ jobs:
           fetch-depth: 1
           ref: "refs/tags/${{ env.RELEASE_TAG }}"
           path: junit-framework
-      - name: Check out samples repository
+      - name: Check out examples repository
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
-          repository: ${{ github.repository_owner }}/junit5-samples
-          token: ${{ secrets.JUNIT_BUILDS_GITHUB_TOKEN_SAMPLES_REPO }}
+          repository: ${{ github.repository_owner }}/junit-examples
+          token: ${{ secrets.JUNIT_BUILDS_GITHUB_TOKEN_EXAMPLES_REPO }}
           fetch-depth: 1
-          path: junit5-samples
+          path: junit-examples
       - name: Set up JDK
         uses: actions/setup-java@c5195efecf7bdfc987ee8bae7a71cb8b11521c00 # v4.7.1
         with:
           java-version: 21
           distribution: temurin
       - uses: sbt/setup-sbt@26ab4b0fa1c47fa62fc1f6e51823a658fb6c760c # v1.1.7
-      - name: Update JUnit dependencies in samples
+      - name: Update JUnit dependencies in examples
         run: java src/Updater.java ${{ inputs.releaseVersion }}
-        working-directory: junit5-samples
+        working-directory: junit-examples
       - name: Prepare Maven Central user token
         uses: ./junit-framework/.github/actions/maven-central-user-token
         with:
           username: ${{ secrets.MAVEN_CENTRAL_USERNAME }}
           password: ${{ secrets.MAVEN_CENTRAL_PASSWORD }}
       - name: Inject staging repository URL
         run: java src/StagingRepoInjector.java ${{ env.STAGING_REPO_URL }}
-        working-directory: junit5-samples
-      - name: Build samples
-        run: java src/Builder.java --exclude=junit5-jupiter-starter-bazel,junit5-jupiter-starter-sbt
-        working-directory: junit5-samples
+        working-directory: junit-examples
+      - name: Build examples
+        run: java src/Builder.java --exclude=junit-jupiter-starter-bazel,junit-jupiter-starter-sbt
+        working-directory: junit-examples
         env:
-          MAVEN_ARGS: --settings ${{ github.workspace }}/junit5-samples/src/central-staging-maven-settings.xml --activate-profiles central-staging
+          MAVEN_ARGS: --settings ${{ github.workspace }}/junit-examples/src/central-staging-maven-settings.xml --activate-profiles central-staging
 
   close_github_milestone:
     name: Close GitHub milestone
@@ -231,26 +231,26 @@ jobs:
           curl --silent --fail --location --output /tmp/junit-user-guide.pdf "${{ steps.pagesDeployment.outputs.pdfUrl }}"
           pdfinfo /tmp/junit-user-guide.pdf
 
-  update_samples:
-    name: Update samples
+  update_examples:
+    name: Update examples
     needs: publish_deployment
     runs-on: ubuntu-latest
     steps:
-      - name: Check out samples repository
+      - name: Check out examples repository
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
-          repository: ${{ github.repository_owner }}/junit5-samples
-          token: ${{ secrets.JUNIT_BUILDS_GITHUB_TOKEN_SAMPLES_REPO }}
+          repository: ${{ github.repository_owner }}/junit-examples
+          token: ${{ secrets.JUNIT_BUILDS_GITHUB_TOKEN_EXAMPLES_REPO }}
           fetch-depth: 1
       - name: Set up JDK
         uses: actions/setup-java@c5195efecf7bdfc987ee8bae7a71cb8b11521c00 # v4.7.1
         with:
           java-version: 21
           distribution: temurin
       - uses: sbt/setup-sbt@26ab4b0fa1c47fa62fc1f6e51823a658fb6c760c # v1.1.7
-      - name: Update JUnit dependencies in samples
+      - name: Update JUnit dependencies in examples
         run: java src/Updater.java ${{ inputs.releaseVersion }}
-      - name: Build samples
+      - name: Build examples
         if: ${{ inputs.dryRun == false }}
         run: java src/Builder.java
       - name: Create release branch
@@ -274,7 +274,7 @@ jobs:
   create_github_release:
     name: Create GitHub release
     if: ${{ inputs.dryRun == false }}
-    needs: [ publish_documentation, update_samples ]
+    needs: [ publish_documentation, update_examples ]
     runs-on: ubuntu-latest
     permissions:
       contents: write

README.md

@@ -20,7 +20,7 @@ This repository is the home of _JUnit 5_.
 - [User Guide]
 - [Javadoc]
 - [Release Notes]
-- [Samples]
+- [Examples]
 
 ## Contributing
 
@@ -102,6 +102,6 @@ of the JUnit Platform, JUnit Jupiter, and JUnit Vintage.
 [Javadoc]: https://docs.junit.org/current/api/
 [JDK 21]: https://javaalmanac.io/jdk/21/
 [Release Notes]: https://docs.junit.org/current/release-notes/
-[Samples]: https://github.com/junit-team/junit5-samples
+[Examples]: https://github.com/junit-team/junit-examples
 [StackOverflow]: https://stackoverflow.com/questions/tagged/junit5
 [User Guide]: https://docs.junit.org/current/user-guide/

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

@@ -229,14 +229,14 @@ endif::[]
 :EnableRuleMigrationSupport:                 {javadoc-root}/org.junit.jupiter.migrationsupport/org/junit/jupiter/migrationsupport/rules/EnableRuleMigrationSupport.html[@EnableRuleMigrationSupport]
 // Vintage
 :junit-vintage-engine:                       {javadoc-root}/org.junit.vintage.engine/org/junit/vintage/engine/package-summary.html[junit-vintage-engine]
-// Samples Repository
-:junit5-samples-repo:                        {junit-team}/junit5-samples
-:junit5-jupiter-starter-ant:                 {junit5-samples-repo}/tree/{release-branch}/junit5-jupiter-starter-ant[junit5-jupiter-starter-ant]
-:junit5-jupiter-starter-gradle-groovy:       {junit5-samples-repo}/tree/{release-branch}/junit5-jupiter-starter-gradle-groovy[junit5-jupiter-starter-gradle-groovy]
-:junit5-jupiter-starter-gradle-kotlin:       {junit5-samples-repo}/tree/{release-branch}/junit5-jupiter-starter-gradle-kotlin[junit5-jupiter-starter-gradle-kotlin]
-:junit5-jupiter-starter-gradle:              {junit5-samples-repo}/tree/{release-branch}/junit5-jupiter-starter-gradle[junit5-jupiter-starter-gradle]
-:junit5-jupiter-starter-maven:               {junit5-samples-repo}/tree/{release-branch}/junit5-jupiter-starter-maven[junit5-jupiter-starter-maven]
-:RandomParametersExtension:                  {junit5-samples-repo}/tree/{release-branch}/junit5-jupiter-extensions/src/main/java/com/example/random/RandomParametersExtension.java[RandomParametersExtension]
+// Examples Repository
+:junit-examples-repo:                        {junit-team}/junit-examples
+:junit-jupiter-starter-ant:                  {junit-examples-repo}/tree/{release-branch}/junit-jupiter-starter-ant[junit-jupiter-starter-ant]
+:junit-jupiter-starter-gradle-groovy:        {junit-examples-repo}/tree/{release-branch}/junit-jupiter-starter-gradle-groovy[junit-jupiter-starter-gradle-groovy]
+:junit-jupiter-starter-gradle-kotlin:        {junit-examples-repo}/tree/{release-branch}/junit-jupiter-starter-gradle-kotlin[junit-jupiter-starter-gradle-kotlin]
+:junit-jupiter-starter-gradle:               {junit-examples-repo}/tree/{release-branch}/junit-jupiter-starter-gradle[junit-jupiter-starter-gradle]
+:junit-jupiter-starter-maven:                {junit-examples-repo}/tree/{release-branch}/junit-jupiter-starter-maven[junit-jupiter-starter-maven]
+:RandomParametersExtension:                  {junit-examples-repo}/tree/{release-branch}/junit-jupiter-extensions/src/main/java/com/example/random/RandomParametersExtension.java[RandomParametersExtension]
 // Third-party Links
 :API:                                        https://apiguardian-team.github.io/apiguardian/docs/current/api/[@API]
 :API_Guardian:                               https://github.com/apiguardian-team/apiguardian[@API Guardian]

documentation/src/docs/asciidoc/user-guide/migration-from-junit4.adoc

@@ -25,7 +25,7 @@ Make sure that the `junit-vintage-engine` artifact is in your test runtime path.
 case JUnit 3 and JUnit 4 tests will automatically be picked up by the JUnit Platform
 launcher.
 
-See the example projects in the {junit5-samples-repo}[`junit5-samples`] repository to
+See the example projects in the {junit-examples-repo}[`junit-examples`] repository to
 find out how this is done with Gradle and Maven.
 
 [[migrating-from-junit4-categories-support]]

documentation/src/docs/asciidoc/user-guide/overview.adoc

@@ -77,14 +77,14 @@ corresponding sections of this User Guide, organized by topic.
 ==== Example Projects
 
 To see complete, working examples of projects that you can copy and experiment with, the
-{junit5-samples-repo}[`junit5-samples`] repository is a good place to start. The
-`junit5-samples` repository hosts a collection of sample projects based on JUnit Jupiter,
+{junit-examples-repo}[`junit-examples`] repository is a good place to start. The
+`junit-examples` repository hosts a collection of example projects based on JUnit Jupiter,
 JUnit Vintage, and other testing frameworks. You'll find appropriate build scripts (e.g.,
 `build.gradle`, `pom.xml`, etc.) in the example projects. The links below highlight some
 of the combinations you can choose from.
 
-* For Gradle and Java, check out the `{junit5-jupiter-starter-gradle}` project.
-* For Gradle and Kotlin, check out the `{junit5-jupiter-starter-gradle-kotlin}` project.
-* For Gradle and Groovy, check out the `{junit5-jupiter-starter-gradle-groovy}` project.
-* For Maven, check out the `{junit5-jupiter-starter-maven}` project.
-* For Ant, check out the `{junit5-jupiter-starter-ant}` project.
+* For Gradle and Java, check out the `{junit-jupiter-starter-gradle}` project.
+* For Gradle and Kotlin, check out the `{junit-jupiter-starter-gradle-kotlin}` project.
+* For Gradle and Groovy, check out the `{junit-jupiter-starter-gradle-groovy}` project.
+* For Maven, check out the `{junit-jupiter-starter-maven}` project.
+* For Ant, check out the `{junit-jupiter-starter-ant}` project.