{"id":13991669,"url":"https://github.com/github/maven-plugins","last_synced_at":"2025-10-19T22:32:53.577Z","repository":{"id":37550400,"uuid":"2144321","full_name":"github/maven-plugins","owner":"github","description":"Official GitHub Maven Plugins","archived":true,"fork":false,"pushed_at":"2023-09-26T19:42:45.000Z","size":1033,"stargazers_count":587,"open_issues_count":83,"forks_count":197,"subscribers_count":306,"default_branch":"master","last_synced_at":"2024-12-17T02:09:10.359Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/github.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2011-08-02T18:39:39.000Z","updated_at":"2024-11-12T04:32:51.000Z","dependencies_parsed_at":"2024-01-15T15:46:36.823Z","dependency_job_id":"6ef0eb90-789f-4081-93af-3b17037a1679","html_url":"https://github.com/github/maven-plugins","commit_stats":{"total_commits":220,"total_committers":17,"mean_commits":"12.941176470588236","dds":0.2272727272727273,"last_synced_commit":"8d6d49393d1453be709ecc4cfe87f41f2081f5c5"},"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github%2Fmaven-plugins","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github%2Fmaven-plugins/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github%2Fmaven-plugins/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github%2Fmaven-plugins/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/github","download_url":"https://codeload.github.com/github/maven-plugins/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237224896,"owners_count":19275106,"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-08-09T14:01:31.219Z","updated_at":"2025-10-19T22:32:48.294Z","avatar_url":"https://github.com/github.png","language":"Java","readme":"# GitHub Maven Plugins [![Build Status](https://travis-ci.org/github/maven-plugins.svg)](https://travis-ci.org/github/maven-plugins)\n\nCollection of [Maven](http://maven.apache.org/) plugins that integrate with GitHub.\nThese plugins are built on top of [API v3](http://developer.github.com/) through the\n[GitHub Java library](https://github.com/eclipse/egit-github/tree/master/org.eclipse.egit.github.core).\n\nReleased builds are available from [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Ccom.github.github).\n\n## Core Configuration\n\nThe plugins support several configuration options that can either be expressed\nin your project's POM file or in your `settings.xml` file. Where you put the\nplugin settings depends on whether you want a specific setting to be configured\nglobally or on a per-project basis.\n\nAll GitHub Maven plugins support the following core configuration elements.\n\nThe notation below shows the plugin configuration property name followed\nby the settings configuration property in parentheses.\n\n* `host` (`github.global.host`)\n  * Domain of GitHub API calls (defaults to `api.github.com`)\n* `oauth2Token` (`github.global.oauth2Token`)\n  * OAuth2 access token for API authentication\n  * [More about GitHub OAuth support](http://developer.github.com/v3/oauth/)\n* `userName` (`github.global.userName`)\n  * GitHub user name used for API authentication\n* `password` (`github.global.password`)\n  * GitHub password used for API authentication\n* `server` (`github.global.server`)\n  * Id of the `server` element from the `settings.xml`. To use standard authentication\n    set  the `username` and `password` elements in the `servers` section of your\n    `settings.xml` file along with an `id`. Configure an OAuth2 token by leaving the\n    `username` element blank/missing and just specify the token in the `password` element.\n  * This option should be used **instead of** configuring any of `userName`, `password`\n    or `oauth2Token` in the plugin `configuration` element or as a properties.\n* `repositoryName`\n  * Name of repository\n* `repositoryOwner`\n  * Owner of repository\n\n*Note:* `repositoryOwner` property and `repositoryName` are optional and will be\ninferred from the following properties if not specified\n\n * `project.scm.url`\n * `project.scm.connection`\n * `project.scm.developerConnection`\n * `project.url`\n\n### Authentication Example\n\n#### settings.xml\n\n```xml\n\u003cservers\u003e\n  \u003cserver\u003e\n    \u003cid\u003egithub\u003c/id\u003e\n    \u003cusername\u003eGitHubLogin\u003c/username\u003e\n    \u003cpassword\u003eGitHubPassw0rd\u003c/password\u003e\n  \u003c/server\u003e\n\u003c/servers\u003e\n```\nor\n```xml\n\u003cservers\u003e\n  \u003cserver\u003e\n    \u003cid\u003egithub\u003c/id\u003e\n    \u003cpassword\u003eOAUTH2TOKEN\u003c/password\u003e\n  \u003c/server\u003e\n\u003c/servers\u003e\n```\n\n#### pom.xml\n\n```xml\n\u003cproperties\u003e\n  \u003cgithub.global.server\u003egithub\u003c/github.global.server\u003e\n\u003c/properties\u003e\n```\n\n## [Site Plugin](http://github.github.com/maven-plugins/site-plugin)\nMaven plugin that commits files generated and updates a specific branch\nreference in a GitHub repository.  This plugin can be used to deploy a created\nMaven site to a `gh-pages` branch so that it can be served statically as a\nGitHub Project Page.  The plugin has a `site` goal and is configured with a goal\nprefix of `ghSite`.\n\n### Configuration\n\n* `branch`\n  * Branch ref that will be updated to commit made\n  * Default: `refs/heads/gh-pages`\n* `message`\n  * Message used for commit\n* `outputDirectory`\n  * Directory that includes and excludes will be relative to\n  * Defaults to `siteOutputDirectory` or `project.reporting.outputDirectory`\n* `includes`\n  * Sub-elements will be treated as patterns to include from the\n    `outputDirectory`\n* `excludes`\n  * Sub-elements will be treated as patterns to exclude from the\n    `outputDirectory`\n* `path`\n  * Path relative to the root of the repository that all blobs should be\n    relative to\n* `force` (`github.site.force`)\n  * `true` | `false` (default: `false`)\n  * Whether to force a ref update, default is fast-forwards only\n* `merge` (`github.site.merge`)\n  * `true` | `false` (default: `false`)\n  * Whether to merge with the current tree or completely replace the tree that\n    the commit points to\n* `dryRun` (`github.site.dryRun`)\n  * `true` | `false` (default: `false`)\n  * Log what blobs, tree, and commits *would* be created without actually\n    creating them\n* `noJekyll` (`github.site.noJekyll`)\n  * `true` | `false` (default: `false`)\n  * Whether to always create a `.nojekyll` file at the root of the site if one\n    doesn't already exist.  This setting should be enabled if your site contains\n    any folders that begin with an underscore.\n\n### Example\n```xml\n\u003cbuild\u003e\n  \u003cplugins\u003e\n    \u003cplugin\u003e\n      \u003cgroupId\u003ecom.github.github\u003c/groupId\u003e\n      \u003cartifactId\u003esite-maven-plugin\u003c/artifactId\u003e\n      \u003cversion\u003e0.12\u003c/version\u003e\n      \u003cconfiguration\u003e\n        \u003cmessage\u003eCreating site for ${project.version}\u003c/message\u003e\n      \u003c/configuration\u003e\n      \u003cexecutions\u003e\n        \u003cexecution\u003e\n          \u003cgoals\u003e\n            \u003cgoal\u003esite\u003c/goal\u003e\n          \u003c/goals\u003e\n          \u003cphase\u003esite\u003c/phase\u003e\n        \u003c/execution\u003e\n      \u003c/executions\u003e\n    \u003c/plugin\u003e\n  \u003c/plugins\u003e\n\u003c/build\u003e\n```\n\nTo commit a created site run the following command:\n\n`$ mvn site`\n\n# License\n* [MIT License](http://www.opensource.org/licenses/mit-license.php)\n","funding_links":[],"categories":["Java"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgithub%2Fmaven-plugins","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgithub%2Fmaven-plugins","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgithub%2Fmaven-plugins/lists"}