Skip to content

Commit c7c5214

Browse files
committed
docs: polishing updates README + template
1 parent 5ddd5fd commit c7c5214

File tree

2 files changed

+13
-15
lines changed

2 files changed

+13
-15
lines changed

.github/template/README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,21 @@
66
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
77
[![Javadoc](https://img.shields.io/badge/JavaDoc-Online-green)](https://%REPO_OWNER%.github.io/%REPO_NAME%/javadoc/)
88

9-
All set up, enjoy the template.
9+
Automated migration completed, enjoy the template.
1010

1111
## Features
1212
- 🥷 One-click **automated initial project migration workflow** (GitHub Action)
1313
- **Java 21** (corretto) 🤝 **Gradle Kotlin DSL**, version catalog
14-
- **GitHub Actions CI/CD pipeline** 👷
14+
- **GitHub Actions CI/CD pipeline**, 👷 efficient build pipeline, caching, integration tests, test report & failed test annotations
1515
- 🚀 **One-click release** process + **publish** to **Maven Central**
1616
- **Security & 🚦 Vulnerability scan** with **[trivy](https://github.com/aquasecurity/trivy)** & GitHub CodeQL Analysis
1717
- **Automated dependency updates** with **[Renovate](https://github.com/renovatebot/renovate)** 🤖
18-
- Efficient build pipeline, integration tests, test report & failed test annotations
19-
- Javadoc deployed with GitHub Pages
20-
- Open Source Community ready (Code of Conduct, Contribution guidelines, Issue & PR Templates)
18+
- **Javadoc** deployed with **GitHub Pages**
19+
- Open Source **Community ready** (Code of Conduct, Contribution guidelines, Issue & PR Templates)
2120

2221
## Quick Start
2322
1. [Use this template](https://github.com/thriving-dev/java-library-template/generate) to create your own repository
24-
2. Manually trigger '[!! INITIAL: Migrate Repo Template !!](https://github.com/%REPO_OWNER%/%REPO_NAME%/actions/workflows/0.initial.migrate-repo-template.yml)' action
23+
2. Manually trigger '**!! INITIAL: Migrate Repo Template !!**' action
2524
> ℹ️ This workflow automatically 'migrates' all files in your new repository, updating the **gradle project group**, **module name**, **package names**, and **all references** to the repo `<owner>/<name>`.
2625
>
2726
> - Head over to **Actions** (1)
@@ -40,12 +39,12 @@ All set up, enjoy the template.
4039
* Install & configure renovate app ([instructions](#prerequisites-enable--configure-renovate))
4140

4241
## Project Structure
43-
The project template consists of three top level folders
42+
The project template consists of three top level _folders_:
4443
* `.github/`: Defines the Github Actions CI tasks and templates for new pull requests, issues, etc.
4544
* `gradle/`: Contains Gradle Configuration files such as the Gradle [Version Catalog](https://docs.gradle.org/current/userguide/platforms.html) and the Gradle Wrapper.
4645
* `%ARTIFACT_NAME%/`: The library source code (gradle sub-project).
4746

48-
In addition, following files are worth highlighting:
47+
In addition, following _files_ are worth highlighting:
4948
* `gradle/libs.versions.toml`: A [conventional file](https://docs.gradle.org/current/userguide/platforms.html#sub:conventional-dependencies-toml) to declare a version catalog.
5049
* `settings.gradle.kts`: The multi-project Gradle settings file. Here are all sub-projects defined.
5150
* `gradle.properties`: Holds the library version, needed & maintained by the CI/CD pipeline [release process](#release-process).

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,16 @@ _TLDR:_ Java Library GitHub Template Repository
1212
## Features
1313
- 🥷 One-click **automated initial project migration workflow** (GitHub Action)
1414
- **Java 21** (corretto) 🤝 **Gradle Kotlin DSL**, version catalog
15-
- **GitHub Actions CI/CD pipeline** 👷
15+
- **GitHub Actions CI/CD pipeline**, 👷 efficient build pipeline, caching, integration tests, test report & failed test annotations
1616
- 🚀 **One-click release** process + **publish** to **Maven Central**
1717
- **Security & 🚦 Vulnerability scan** with **[trivy](https://github.com/aquasecurity/trivy)** & GitHub CodeQL Analysis
1818
- **Automated dependency updates** with **[Renovate](https://github.com/renovatebot/renovate)** 🤖
19-
- Efficient build pipeline, integration tests, test report & failed test annotations
20-
- Javadoc deployed with GitHub Pages
21-
- Open Source Community ready (Code of Conduct, Contribution guidelines, Issue & PR Templates)
19+
- **Javadoc** deployed with **GitHub Pages**
20+
- Open Source **Community ready** (Code of Conduct, Contribution guidelines, Issue & PR Templates)
2221

2322
## Quick Start
2423
1. [Use this template](https://github.com/thriving-dev/java-library-template/generate) to create your own repository
25-
2. Manually trigger '[!! INITIAL: Migrate Repo Template !!](https://github.com/thriving-dev/java-library-template/actions/workflows/0.initial.migrate-repo-template.yml)' action
24+
2. Manually trigger '**!! INITIAL: Migrate Repo Template !!**' action
2625
> ℹ️ This workflow automatically 'migrates' all files in your new repository, updating the **gradle project group**, **module name**, **package names**, and **all references** to the repo `<owner>/<name>`.
2726
>
2827
> - Head over to **Actions** (1)
@@ -41,12 +40,12 @@ _TLDR:_ Java Library GitHub Template Repository
4140
* Install & configure renovate app ([instructions](#prerequisites-enable--configure-renovate))
4241

4342
## Project Structure
44-
The project template consists of three top level folders
43+
The project template consists of three top level _folders_:
4544
* `.github/`: Defines the Github Actions CI tasks and templates for new pull requests, issues, etc.
4645
* `gradle/`: Contains Gradle Configuration files such as the Gradle [Version Catalog](https://docs.gradle.org/current/userguide/platforms.html) and the Gradle Wrapper.
4746
* `java-library-template/`: The library source code (gradle sub-project).
4847

49-
In addition, following files are worth highlighting:
48+
In addition, following _files_ are worth highlighting:
5049
* `gradle/libs.versions.toml`: A [conventional file](https://docs.gradle.org/current/userguide/platforms.html#sub:conventional-dependencies-toml) to declare a version catalog.
5150
* `settings.gradle.kts`: The multi-project Gradle settings file. Here are all sub-projects defined.
5251
* `gradle.properties`: Holds the library version, needed & maintained by the CI/CD pipeline [release process](#release-process).

0 commit comments

Comments
 (0)