{"id":20802456,"url":"https://github.com/git-commit-id/git-commit-id-gradle-plugin","last_synced_at":"2025-05-07T01:03:56.976Z","repository":{"id":158819448,"uuid":"627144878","full_name":"git-commit-id/git-commit-id-gradle-plugin","owner":"git-commit-id","description":"Gradle plugin which includes build-time git repository information into an POJO / *.properties). Make your apps tell you which version exactly they were built from! Priceless in large distributed deployments... :-)","archived":false,"fork":false,"pushed_at":"2024-10-21T17:14:32.000Z","size":265,"stargazers_count":10,"open_issues_count":6,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-07T01:02:19.674Z","etag":null,"topics":["build-automation","continuous-delivery","git","gradle","gradle-plugin","versioning"],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/git-commit-id.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}},"created_at":"2023-04-12T21:57:51.000Z","updated_at":"2025-02-04T10:46:47.000Z","dependencies_parsed_at":"2024-07-23T00:13:44.351Z","dependency_job_id":null,"html_url":"https://github.com/git-commit-id/git-commit-id-gradle-plugin","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/git-commit-id%2Fgit-commit-id-gradle-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/git-commit-id%2Fgit-commit-id-gradle-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/git-commit-id%2Fgit-commit-id-gradle-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/git-commit-id%2Fgit-commit-id-gradle-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/git-commit-id","download_url":"https://codeload.github.com/git-commit-id/git-commit-id-gradle-plugin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252793664,"owners_count":21805057,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["build-automation","continuous-delivery","git","gradle","gradle-plugin","versioning"],"created_at":"2024-11-17T18:31:53.414Z","updated_at":"2025-05-07T01:03:56.969Z","avatar_url":"https://github.com/git-commit-id.png","language":"Java","readme":"# git-commit-id-gradle-plugin\ngit-commit-id-gradle-plugin is a plugin quite similar to [git-commit-id-maven-plugin](https://github.com/git-commit-id/git-commit-id-maven-plugin/) but for gradle!\nFor those who don't know the plugin, it basically helps you with the following tasks and answers related questions\n* Which version had the bug? Is that deployed already?\n* Make your distributed deployment aware of versions\n* Validate if properties are set as expected\n\nGetting the plugin\n==================\nThe plugin **unreleased**!\n\nUsing the plugin\n==================\nTo make use of the plugin you must apply the plugin in your `build.gradle` as mentioned in the [gradle documentation](https://docs.gradle.org/current/userguide/plugins.html#sec:plugins_block):\n```groovy\nplugins {\n    id 'java'\n    id 'io.github.git-commit-id.git-commit-id-gradle-plugin'\n}\n```\nor if you want to use a specific version of the plugin via:\n```groovy\nplugins {\n    id 'java'\n    id 'io.github.git-commit-id.git-commit-id-gradle-plugin' version 'MAJOR.MINOR.PATCH'\n}\n```\nThis plugin follows the [Semantic Versioning](https://semver.org/) that roughly can be \nsummarized as a version number `MAJOR.MINOR.PATCH`, increment the:\n- `MAJOR` version when you make incompatible API changes\n- `MINOR` version when you add functionality in a backwards compatible manner\n- `PATCH` version when you make backwards compatible bug fixes\n\n\nConfigure the plugin\n==================\nThis plugin comes with a sensible set of default of configurations and settings.\nHowever, there might be cases where a default doesn't fit your project needs.\nGradle allows user to configure with [Modeling DSL-like APIs](https://docs.gradle.org/current/userguide/implementing_gradle_plugins.html#modeling_dsl_like_apis).\nPerhaps one additional item you need to know about configuration is that the plugin makes\nuse of gradle's [Lazy Configuration](https://docs.gradle.org/current/userguide/lazy_configuration.html) which is gradle's\nway to manage growing build complexity.\n\nIn short the plugin can be configured by adding a block like this to your `build.gradle`:\n```groovy\ngitCommitId {\n    skip.set(false)\n}\n```\n\nRefer to **TODO** for all the settings and in-depth explanations what the individual configurations are there for.\n\nVersions\n--------\nThe current version is **unreleased**\n\n\nPlugin compatibility with Gradle\n-----------------------------\nThis project requires *at least java 11* and will rely on gradle's convention for configuration.\nYou also will need *at least a gradle 5.3** installation to be able to use this plugin.\n\nIn case you are interested here are more details about the specifics for the version requirements:\n- The [git-commit-id-plugin-core](https://github.com/git-commit-id/git-commit-id-plugin-core)\n  which provides the core functions for gathering the git information relies on [JGit](https://wiki.eclipse.org/JGit)\n  that is a pure Java library implementing the Git version control file access routines.\n  With version [6.0](https://wiki.eclipse.org/JGit/New_and_Noteworthy/6.0) this library requires Java 11 to run.\n- With [Gradle's Compatibility Matrix](https://docs.gradle.org/current/userguide/compatibility.html) the\n  minimum supported gradle version is 5.0.\n- This plugin relies on conventions that had been introduced as part of the [Lazy Configuration](https://docs.gradle.org/current/userguide/lazy_configuration.html).\n  Such conventions had been made available with [gradle 5.1](https://docs.gradle.org/5.1/release-notes.html)\n- The GitCommitIdPluginExtension is made abstract and uses an `Injection` annotation that only\n  works with gradle 5.3 and onwards. For more details refer to https://github.com/gradle/gradle/issues/24947.\n\n\nMaintainers\n===========\nThis project is currently maintained thanks to: @TheSnoozer\n\n\nNotable contributions\n=====================\n* @ktoso (founder) for the initial idea of the git-commit-id-maven-plugin\n* @jbellmann for starting the initiative to make the maven plugin available for gradle ([see here](https://github.com/git-commit-id/git-commit-id-maven-plugin/pull/92))\n\nLicense\n=======\nthis plugin is released under the **GNU Lesser General Public License 3.0**.\n\nYou're free to use it as you wish, the full license text is attached in the [LICENSE](https://github.com/git-commit-id/git-commit-id-gradle-plugin/blob/main/LICENSE) file.\n\nFeature requests\n================\nThe best way to ask for features / improvements is [via the Issues section on GitHub](https://github.com/git-commit-id/git-commit-id-gradle-plugin/issues/new/choose)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgit-commit-id%2Fgit-commit-id-gradle-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgit-commit-id%2Fgit-commit-id-gradle-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgit-commit-id%2Fgit-commit-id-gradle-plugin/lists"}