{"id":16559352,"url":"https://github.com/mathieusoysal/java-maven-library-template","last_synced_at":"2025-10-28T21:30:24.856Z","repository":{"id":44670205,"uuid":"441750951","full_name":"MathieuSoysal/Java-Maven-library-template","owner":"MathieuSoysal","description":"Template to easily create a Java library and automatically publish it to GitHub Package and Maven Central.","archived":false,"fork":false,"pushed_at":"2023-07-12T09:45:05.000Z","size":269,"stargazers_count":3,"open_issues_count":7,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-08T20:52:35.630Z","etag":null,"topics":["hacktoberfest","java","library-template","maven","maven-library-template"],"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/MathieuSoysal.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-12-25T20:09:56.000Z","updated_at":"2024-03-01T03:00:27.000Z","dependencies_parsed_at":"2022-08-23T17:00:32.979Z","dependency_job_id":null,"html_url":"https://github.com/MathieuSoysal/Java-Maven-library-template","commit_stats":null,"previous_names":[],"tags_count":1,"template":true,"template_full_name":"MathieuSoysal/Java-Maven-Project-Template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MathieuSoysal%2FJava-Maven-library-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MathieuSoysal%2FJava-Maven-library-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MathieuSoysal%2FJava-Maven-library-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MathieuSoysal%2FJava-Maven-library-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MathieuSoysal","download_url":"https://codeload.github.com/MathieuSoysal/Java-Maven-library-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238720308,"owners_count":19519326,"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":["hacktoberfest","java","library-template","maven","maven-library-template"],"created_at":"2024-10-11T20:25:38.790Z","updated_at":"2025-10-28T21:30:19.515Z","avatar_url":"https://github.com/MathieuSoysal.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=MathieuSoysal_Java-Maven-library-template\u0026metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=MathieuSoysal_Java-Maven-library-template)\n[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=MathieuSoysal_Java-Maven-library-template\u0026metric=coverage)](https://sonarcloud.io/summary/new_code?id=MathieuSoysal_Java-Maven-library-template)\n[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=MathieuSoysal_Java-Maven-library-template\u0026metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=MathieuSoysal_Java-Maven-library-template)\n![GitHub Actions](https://github.com/MathieuSoysal/Java-Maven-library-template/workflows/Java%20CI%20with%20Maven/badge.svg)\n[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md) \n[![Javadoc](https://img.shields.io/badge/JavaDoc-Online-green)](https://mathieusoysal.github.io/Java-Maven-library-template/javadoc/)\n\n\n# \u003cimg src=\"https://cdn.iconscout.com/icon/free/png-512/java-43-569305.png\" width=\"100\"\u003e Java Maven Library Template [![GitHub](https://img.shields.io/badge/license-Apache%202.0%20License-green)](LICENSE)\n\nTemplate to easily create a Java Maven library and publish it automatically on GitHub Package and Maven Central, the publication is automated via the repo versions.\n\n## Use template\n\nTo use this template, you just need to click on \"Use this template\" at the top of the main page of this repository, or you can copy/paste this repository.\n\n## Requirements\n- [ ] [Create an account on Sonatype](https://issues.sonatype.org/secure/Signup!default.jspa)\n- [ ] [Create a JIRA ticket on Sonatype to approve your groupId (io.github.YOUR-GITHUB-USERNAME)](https://issues.sonatype.org/secure/CreateIssue.jspa?issuetype=21\u0026pid=10134)\n- [ ] [Generate a gpg key and distribute the public key to a keyserver](https://central.sonatype.org/publish/requirements/gpg/)\n\n## Template configurations :\n\n- [ ] **Fix pom.xml**\n  - *To guide you, a FIXME tag has been added to all lines to be edited.*\n- [ ] **Config SonarCloud**\n  - To configure SonarCloud for your project you must go to https://sonarcloud.io\n  - Replace the file at [/.github/workflows/sonar.yml](.github/workflows/sonar.yml) with your own yaml file at https://sonarcloud.io and if your Java project is not on Java 11 edit that yaml file.\n- [ ] **Create your GitHub secrets on your repository**\n  - *NEXUS_USERNAME* with your username used on Sonatype\n  - *NEXUS_PASSWORD* with your password used on Sonatype\n  - *GPG_PRIVATE_KEY* with the private key of your generated pgp key\n    - to get the private key `gpg --armor --export-secret-key \u003ckey-id\u003e \u003e privkey.asc` \n  - *GPG_PASSPHRASE* with the passphrase of your gpg key\n- [ ] **Activate the JavaDoc GitHub page**\n  - To enable the JavaDoc GitHub Page, you need to enable the GitHub page in your repository settings for the *javadoc* branch.\n\n## Badges\n\nDon't forget to add your own SonarCloud badges to your readme 😉\n - to get your maven-central badge : https://shields.io/category/platform-support\n - to get your JavaDoc Badge : \n```Markdown\n  [![Javadoc](https://img.shields.io/badge/JavaDoc-Online-green)](https://\u003cgithub-username\u003e.github.io/\u003cgithub-repo\u003e/javadoc/)\n```\nOn the link of JavaDoc badge, replace  `\u003cgithub-username\u003e` by your GitHub username, `\u003cgithub-repo\u003e` by the name of your GitHub repository.\n\n## Contact\n\nIf you have any problems setting up CI, CD or other, do not hesitate to contact me at Mathieu.Soysal@etu.umontpellier.fr\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmathieusoysal%2Fjava-maven-library-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmathieusoysal%2Fjava-maven-library-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmathieusoysal%2Fjava-maven-library-template/lists"}