{"id":16416051,"url":"https://github.com/phax/ph-buildinfo-maven-plugin","last_synced_at":"2025-04-23T01:53:35.046Z","repository":{"id":20085607,"uuid":"23354775","full_name":"phax/ph-buildinfo-maven-plugin","owner":"phax","description":"A Maven 3 plugin that adds build information to the resulting artefacts","archived":false,"fork":false,"pushed_at":"2025-04-14T19:04:17.000Z","size":246,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-23T01:53:30.430Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/phax.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2014-08-26T14:34:31.000Z","updated_at":"2025-04-14T19:04:21.000Z","dependencies_parsed_at":"2023-11-07T14:41:08.889Z","dependency_job_id":"186e5a8a-3ab0-4da0-890f-d7cf8026abd8","html_url":"https://github.com/phax/ph-buildinfo-maven-plugin","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phax%2Fph-buildinfo-maven-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phax%2Fph-buildinfo-maven-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phax%2Fph-buildinfo-maven-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/phax%2Fph-buildinfo-maven-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/phax","download_url":"https://codeload.github.com/phax/ph-buildinfo-maven-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250354301,"owners_count":21416751,"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":[],"created_at":"2024-10-11T07:08:15.254Z","updated_at":"2025-04-23T01:53:35.021Z","avatar_url":"https://github.com/phax.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ph-buildinfo-maven-plugin\n\n[![javadoc](https://javadoc.io/badge2/com.helger.maven/ph-buildinfo-maven-plugin/javadoc.svg)](https://javadoc.io/doc/com.helger.maven/ph-buildinfo-maven-plugin)\n[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.helger.maven/ph-buildinfo-maven-plugin/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.helger.maven/ph-buildinfo-maven-plugin) \n\nA Maven 3 plugin that adds build information to the resulting artefacts.\nIt allows to add an XML and/or a Properties file to the resulting artefact.\n\n## Maven configuration\n\n```xml\n\u003cplugin\u003e\n  \u003cgroupId\u003ecom.helger.maven\u003c/groupId\u003e\n  \u003cartifactId\u003eph-buildinfo-maven-plugin\u003c/artifactId\u003e\n  \u003cversion\u003e4.0.1\u003c/version\u003e\n  \u003cexecutions\u003e\n    \u003cexecution\u003e\n      \u003cgoals\u003e\n        \u003cgoal\u003egenerate-buildinfo\u003c/goal\u003e\n      \u003c/goals\u003e\n    \u003c/execution\u003e\n  \u003c/executions\u003e\n  \u003cconfiguration\u003e\n    \u003cformatProperties\u003efalse\u003c/formatProperties\u003e\n    \u003cformatXML\u003etrue\u003c/formatXML\u003e\n    \u003cformatJson\u003efalse\u003c/formatJson\u003e\n    \u003cwithAllSystemProperties\u003etrue\u003c/withAllSystemProperties\u003e\n    \u003cselectedEnvVars\u003e\n      \u003cparam\u003eJAVA_.*\u003c/param\u003e\n      \u003cparam\u003eM2_.*\u003c/param\u003e\n      \u003cparam\u003eMAVEN_.*\u003c/param\u003e\n      \u003cparam\u003eNUMBER_OF_PROCESSORS\u003c/param\u003e\n      \u003cparam\u003eOS\u003c/param\u003e\n      \u003cparam\u003ePROCESSOR_.*\u003c/param\u003e\n    \u003c/selectedEnvVars\u003e\n  \u003c/configuration\u003e\n\u003c/plugin\u003e\n```\n\nConfiguration items are:\n\n* `HashSet \u003cString\u003e` **ignoredPackagings**  \n  A set of ignored packagings for which the buildinfo plugin is not executed.\n  Defaults to `pom`.\n  Since v2.1.0 \n* `File` **tempDirectory**  \n  The directory where the temporary buildinfo files will be saved.  \n  Defaults to `${project.build.directory}/buildinfo-maven-plugin`\n* `boolean` **withAllSystemProperties**  \n  Should all system properties be emitted into the build info? \n  If this flag is set, the **selectedSystemProperties** are cleared, so either this flag or\n  the **selectedSystemProperties** should be used. All contained system properties are prefixed with\n  `systemproperty.` in the generated file.  \n  Defaults to `false`.\n* `HashSet \u003cString\u003e` **selectedSystemProperties**  \n   A selected subset of system property names \n   to be emitted. Each element can be a regular expression to match more than one potential \n   system property. If this set is not empty, the **withSystemProperties** property should not \n   need to be enabled. All contained system properties are prefixed with `systemproperty.`\n   in the generated file.\n* `HashSet\u003cString\u003e` **ignoredSystemProperties**  \n   A selected subset of system property names \n   to be ignored. Each element can be a regular expression to match more than one potential system\n   property. Ignored system properties take precedence over selected system properties. \n   They are also ignored if **withAllSystemProperties** is set to `true`.\n* `boolean` **withAllEnvVars**  \n   Should all environment variables be emitted into the build info? If this flag is set, \n   the selectedEnvVars are cleared, so either this flag or the **selectedEnvVars** should be used.\n   All contained environment variables are prefixed with `envvar.` in the generated file.  \n   Defaults to `false`.\n* `HashSet \u003cString\u003e` **selectedEnvVars**  \n   A selected subset of environment variables names to be emitted. Each element can be \n   a regular expression to match more than one potential environment variables. \n   If this set is not empty, the **withEnvVars** property does not need to be enabled.\n   All contained environment variables are prefixed with `envvar.` in the generated file.\n* `HashSet \u003cString\u003e` **ignoredEnvVars**  \n   A selected subset of environment variables names to be ignored. Each element can be a \n   regular expression to match more than one potential environment variables. Ignored \n   environment variables take precedence over selected environment variables.\n   They are also ignored if withAllEnvVars is set to `true`.\n* `boolean` **formatXML**  \n   Generate build info in .XML format? It is safe to generate multiple formats in one run!  \n   Defaults to `true`.  \n   The created file is always **targetPath** + `buildinfo.xml`.  \n   The generated file has the following layout:\n```xml     \n\u003cmapping\u003e\n  \u003cmap key=\"buildinfo.version\" value=\"3\" /\u003e\n  \u003cmap key=\"project.groupid\" value=\"com.helger.maven\" /\u003e\n  ...\n\u003c/mapping\u003e\n```\n\n* `boolean` **formatProperties**  \n  Generate build info in .properties format? It is safe to generate multiple formats in one run!  \n  Defaults to `false`.\n  The created file is always **targetPath** + `buildinfo.properties`.\n* `boolean` **formatJson**  \n  Generate build info in .json format? It is safe to generate multiple formats in one run!  \n  Defaults to `false`.\n  The created file is always **targetPath** + `buildinfo.json`.\n  Since v2.1.0.\n* `String` **targetPath**  \n  Set the target path inside the final artefact where the files should be located.\n  Defaults to `META-INF`.\n  Since v2.1.0.\n\n# News and noteworthy\n\n* v4.0.1 - 2023-07-01\n    * Make sure all Maven dependencies are in scope `provided`\n    * Removed the `maven-compat` dependencies for Maven 4 compatibility\n* v4.0.0 - 2023-01-08\n    * Using Java 11 as the baseline\n    * Updated to ph-commons 11\n* v3.0.2 - 2021-03-22\n    * Updated to ph-commons 10\n* v3.0.1 - 2020-03-11\n    * Release with recent library versions\n* v3.0.0 - 2018-08-06\n    * Updated to ph-commons 9.0.0\n* v2.1.0 - 2017-04-11\n    * Updated buildinfo version number to `3`\n        * List of active profiles were added to build info output\n        * Changed property name `build.datetime` to `build.datetime.text`\n        * Changed property name `build.datetime.timezone` to `build.datetime.timezone.id`\n    * Switched to Maven plugin annotations\n    * Marked as thread-safe\n    * Timezone is now considered\n    * Added new property `ignoredPackagings` to define Maven packagings to be ignored for this plugin.\n    * Added new property `targetPath` to define the path in the final artefact\n    * Added support for writing JSON buildinfo files\n* v2.0.0 - 2016-07-01\n    * Updated to Java 8\n* v1.3.0 - 2015-08-31\n    * First version to require Maven 3.0\n    * Removed manual SLF4J integration\n    * Added support for Eclipse m2e plugin\n* v1.2.2 - 2015-03-11\n    * Last version to support Maven 2.x\n* v1.2.1 - 2014-09-02\n    * Tried to make compatible with Maven 2.2.1\n* v1.2.0 - 2014-08-26\n\n---\n\nMy personal [Coding Styleguide](https://github.com/phax/meta/blob/master/CodingStyleguide.md) |\nIt is appreciated if you star the GitHub project if you like it.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphax%2Fph-buildinfo-maven-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fphax%2Fph-buildinfo-maven-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphax%2Fph-buildinfo-maven-plugin/lists"}