{"id":37020839,"url":"https://github.com/jagodevreede/semver-check","last_synced_at":"2026-01-14T02:26:11.452Z","repository":{"id":64555593,"uuid":"567455142","full_name":"jagodevreede/semver-check","owner":"jagodevreede","description":"A maven plugin that allows you to check (or determine) the next version of your module, based on the rules of Semantic Versioning.","archived":false,"fork":false,"pushed_at":"2026-01-12T23:00:14.000Z","size":308,"stargazers_count":31,"open_issues_count":5,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-13T00:38:25.437Z","etag":null,"topics":["java","maven-plugin","semantic-versioning","semver"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jagodevreede.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-11-17T20:37:46.000Z","updated_at":"2026-01-12T19:09:41.000Z","dependencies_parsed_at":"2023-11-17T21:28:47.142Z","dependency_job_id":"667a7681-d333-41b7-8f6c-b515995dc803","html_url":"https://github.com/jagodevreede/semver-check","commit_stats":null,"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"purl":"pkg:github/jagodevreede/semver-check","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jagodevreede%2Fsemver-check","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jagodevreede%2Fsemver-check/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jagodevreede%2Fsemver-check/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jagodevreede%2Fsemver-check/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jagodevreede","download_url":"https://codeload.github.com/jagodevreede/semver-check/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jagodevreede%2Fsemver-check/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28408711,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T01:52:23.358Z","status":"online","status_checked_at":"2026-01-14T02:00:06.678Z","response_time":107,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["java","maven-plugin","semantic-versioning","semver"],"created_at":"2026-01-14T02:26:10.724Z","updated_at":"2026-01-14T02:26:11.426Z","avatar_url":"https://github.com/jagodevreede.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SemVer check\n\n![GitHub](https://img.shields.io/github/license/jagodevreede/semver-check)\n![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/jagodevreede/semver-check?label=Latest%20release)\n![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/jagodevreede/semver-check/maven.yml?branch=main)\n\nThis maven plugin allows you to check (or determine) the next version of your module, based on the rules\nof [Semantic Versioning](https://semver.org/).\n\n## Prerequisites\n\nThis plugin requires Maven 3.3.9 and Java 11 or higher to be able to run.\nTested working on maven 4-RC4 and JDK 25.\n\n## Usage\n\nThere is an [example project](semver-check-maven-plugin-example) that has a minimum configuration but all options\nspecified.\n\nAdd the following configuration to your `pom.xml` and set the VERSION_NUMBER to the latest version released.\n\n```xml\n\n\u003cbuild\u003e\n    ...\n    \u003cplugins\u003e\n        ...\n        \u003cplugin\u003e\n            \u003cartifactId\u003esemver-check-maven-plugin\u003c/artifactId\u003e\n            \u003cgroupId\u003eio.github.jagodevreede\u003c/groupId\u003e\n            \u003cversion\u003eVERSION_NUMBER\u003c/version\u003e\n            \u003cconfiguration\u003e\n                \u003chaltOnFailure\u003etrue\u003c/haltOnFailure\u003e\n                \u003coutputFileName\u003enextVersion.txt\u003c/outputFileName\u003e\n            \u003c/configuration\u003e\n            \u003cexecutions\u003e\n                \u003cexecution\u003e\n                    \u003cid\u003echeck\u003c/id\u003e\n                    \u003cphase\u003everify\u003c/phase\u003e\n                    \u003cgoals\u003e\n                        \u003cgoal\u003echeck\u003c/goal\u003e\n                    \u003c/goals\u003e\n                \u003c/execution\u003e\n            \u003c/executions\u003e\n        \u003c/plugin\u003e\n        ...\n    \u003c/plugins\u003e\n    ...\n\u003c/build\u003e\n```\n\nThis plugin can be used with a multimodule project, an example project can be\nfound [here](https://github.com/jagodevreede/semver-check/tree/main/semver-check-maven-plugin-multi-module-example).\n\n## Configuration\n\nThe following configuration options are available:\n\n| Property name             | Default value     | Description                                                                                                                                                                                                         |\n|---------------------------|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| skip                      | `false`           | If set to `true` then the build will skip the execution of this plugin                                                                                                                                              |\n| skipDependencyCheck       | `false`           | If set to `true` then the dependencies will not be compared to the previous version                                                                                                                                 |\n| haltOnFailure             | `true`            | If set to `false` then the build will not fail if the plugin encounter a problem, but only log a warning                                                                                                            |\n| ignoreSnapshots           | `true`            | If set to `false` then the plugin will also compare to SNAPSHOT versions if it can find any (in local repo's for example)                                                                                           |\n| outputFileName            | `nextVersion.txt` | The name of the file where the next version in plain text will be written to. This file is located in the `target` folder. If the property is left empty then no file will be created                               |\n| writeFileOnNone           | `true`            | If set to `false` then the output file will not be written if the determined version upgrade type is `none`                                                                                                         |\n| overwriteOutputFile       | `true`            | If set to `false` then the output file will not be overwritten.                                                                                                                                                     |\n| includePackages           |                   | Only uses packages in the list and ignores any others, can be a comma separated list or a list of includePackage. Values are a regex pattern (See [example project](semver-check-maven-plugin-example) for example) |\n| excludePackages           |                   | Ignores packages can be a comma separated list or a list of excludePackage. Values are a regex pattern (See [example project](semver-check-maven-plugin-example) for example)                                       |\n| excludeFiles              |                   | Ignores files in match the regex with given here. Can be a comma separated list or a list of excludeFile (See [example project](semver-check-maven-plugin-example) for example)                                     |\n| failOnIncorrectVersion    | `false`           | If set to `true` then if the semver mismatches the build will fail.                                                                                                                                                 |\n| allowHigherVersions       | `true`            | Only has effect when `failOnIncorrectVersion` is set.  If allowHigherVersions set to `false` it will also break if it detected a is lower then expected version.                                                    |\n| annotationAddedStrategy   | `MINOR`           | Strategy to use when an annotation is added. Possible values: MAJOR, MINOR, PATCH, NONE                                                                                                                             |\n| annotationRemovedStrategy | `MAJOR`           | Strategy to use when an annotation is removed. Possible values: MAJOR, MINOR, PATCH, NONE.                                                                                                                          |\n\n## How is the semver type determined\n\n### Major\n\n- Changing the java version of the compiled classes to a higher version.\n- Removal of a public class, method, field or static variable.\n- Removal of a resource file\n- Removal of an annotation on a public API\n\n### Minor\n\n- Addition of a public class, method, annotation, field or static variable.\n- Removal of an annotation on a non public API\n\n## Patch\n\n- Any change that changes the byte code\n- Any change in a resource file (Note that files in META-INF/maven/ are ignored as they are generated by maven)\n- Any change in a dependency\n\n## Known limitations\n\nJava modules (JPMS) are not supported yet, tracked as\nissue [#65](https://github.com/jagodevreede/semver-check/issues/65)\n\n## Getting involved\n\nIf you have questions, concerns, bug reports, etc, please file an issue in this repository's Issue Tracker, or better\nyet create a Pull Request\n\nIf you contribute to this project please follow\nthe [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) specification for commit messages.\n\n## How to release\n\nAll automated with the github release action.\n\n**Prerequisites:**\n\n- Have pgp keys setup on your machine\n- Have access to the group id on https://s01.oss.sonatype.org/\n- Have [jreleaser](https://jreleaser.org/guide/latest/install.html) installed\n\nFirst set the correct version to be released:\n\n\u003e ```mvn versions:set -DnewVersion=1.2.3```\n\nTag this release with tag v1.2.3\n\nThen stage the release:\n\n\u003e ```mvn -Ppublication clean deploy -DaltDeploymentRepository=local::default::file://`pwd`/target/staging-deploy```\n\nThe start the actual release:\n\n\u003e ```mvn -Ppublication jreleaser:full-release```\n\u003e Add dry drun if you first need to check what it will do:\n\u003e `-Djreleaser.dry.run=true`\n\nLastly set the next snapshot version:\n\n\u003e ```mvn versions:set -DnewVersion=1.2.4-SNAPSHOT```\n\nClose the release in maven central at https://s01.oss.sonatype.org/#stagingRepositories\n\n----\n\n## Open source licensing info\n\n1. [LICENSE](LICENSE)\n\n----\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjagodevreede%2Fsemver-check","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjagodevreede%2Fsemver-check","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjagodevreede%2Fsemver-check/lists"}