cthing-annotations

A library providing various annotations to enhance code quality and readability.

Annotation	Description
AccessForTesting	A marker annotation to indicate that a method, constructor or type is given increased access for testing purposes.
NoCoverageGenerated	An annotation to indicate to test coverage tools that the annotated item should be excluded from analysis.
PackageNonnullByDefault	Declares that fields, method return types, method parameters, and type parameters within the annotated package are not null by default.

Read the initial release blog post and browse the Javadoc for more information.

Usage

The library is available from Maven Central using the following Maven dependency:

<dependency>
  <groupId>org.cthing</groupId>
  <artifactId>cthing-annotations</artifactId>
  <version>1.0.0</version>
</dependency>

or the following Gradle dependency:

implementation("org.cthing:cthing-annotations:1.0.0")

Building

The library is compiled for Java 17. If a Java 17 toolchain is not available, one will be downloaded.

Gradle is used to build the library:

./gradlew build

The Javadoc for the library can be generated by running:

./gradlew javadoc

Releasing

This project is released on the Maven Central repository. Perform the following steps to create a release.

• Commit all changes for the release
• In the build.gradle.kts file
  • Ensure that baseVersion is set to the version for the release. The project follows semantic versioning.
  • Set isSnapshot to false
• Commit the changes
• Wait until CI builds the release candidate
• Run the command mkrelease cthing-annotations <version>
• In a browser go to the Maven Central Repository Manager
• Log in
• Use the Staging Upload to upload the generated artifact bundle cthing-annotations-bundle-<version>.jar
• Click on Staging Repositories
• Once it is enabled, press Release to release the artifacts to Maven Central
• Log out
• Wait for the new release to be available on Maven Central
• In a browser, go to the project on GitHub
• Generate a release with the tag <version>
• In the build.gradle.kts file
  • Increment the baseVersion patch number
  • Set isSnapshot to true
• Update the CHANGELOG.md with the changes in the release and prepare for next release changes
• Update the Usage section in the README.md with the latest artifact release version
• Commit these changes