Update pom.xml, README.md, add CHANGELOG.md

- pom.xml: - update parent POM reference - update groupId to `io.github.mavenplugins` - update `version.java` `1.6` -> `1.8` - update URLs to fit with new repo location - README.md: - add URLs for build badges - UnleashGitMerger.java: - fix JavaDoc warnings - closes #1
mavenplugins · Jan 30, 2024 · c91c0c8 · c91c0c8
1 parent 49fb551
commit c91c0c8
Show file tree

Hide file tree

Showing 4 changed files with 134 additions and 25 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,101 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+<!-- Format restrictions - see https://common-changelog.org and https://keepachangelog.com/ for details -->
+<!-- Each Release must start with a line for the release version of exactly this format: ## [version] -->
+<!-- The subsequent comment lines start with a space - not to irritate the release scripts parser!
+ ## [major.minor.micro]
+ <empty line> - optional sub sections may follow like:
+ ### Added:
+ - This feature was added
+ <empty line>
+ ### Changed:
+ - This feature was changed
+ <empty line>
+ ### Removed:
+ - This feature was removed
+ <empty line>
+ ### Fixed:
+ - This issue was fixed
+ <empty line>
+ <empty line> - next line is the starting of the previous release
+ ## [major.minor.micro]
+ <empty line>
+ <...>
+ !!! In addition the compare URL links are to be maintained at the end of this CHANGELOG.md as follows.
+     These links provide direct access to the GitHub compare vs. the previous release.
+     The particular link of a released version will be copied to the release notes of a release accordingly.
+     At the end of this file appropriate compare links have to be maintained for each release version in format:
+ 
+  +-current release version
+  |
+  |                   +-URL to this repo                  previous release version tag-+       +-current release version tag
+  |                   |                                                                |       |
+ [major.minor.micro]: https://github.com/mavenplugins/unleash-scm-provider-git/compare/vM.N.u..vM.N.u
+-->
+<!--
+## [Unreleased]
+
+### Additions
+- TBD
+
+### Changes
+- TBD
+
+### Deprecated
+- TBD
+
+###	Removals
+- TBD
+
+### Fixes
+- TBD
+
+###	Security
+- TBD
+-->
+
+## [Unreleased]
+
+### Changes
+- TBD
+
+
+## [2.3.0]
+<!-- !!! Align version in badge URLs as well !!! -->
+[![2.3.0 Badge](https://img.shields.io/nexus/r/io.github.mavenplugins/unleash-scm-provider-git?server=https://s01.oss.sonatype.org&label=Maven%20Central&queryOpt=:v=2.3.0)](https://central.sonatype.com/artifact/io.github.mavenplugins/unleash-scm-provider-git/2.3.0)
+
+### Summary
+- Initial release of this artifact with new groupId `io.github.mavenplugins`
+- Codewise identical with `com.itemis.maven.plugins:unleash-scm-provider-git:2.3.0`<br>No more features nor changes
+- Update Java compile version to `1.8` to comply with dependency `io.github.mavenplugins:unleash-scm-provider-api:2.10.0`
+- Update m2e launch config to Eclipse 2023-12
+- Released to Maven Central
+
+### Updates
+- pom.xml:
+  - update parent POMreference
+  - update groupId to `io.github.mavenplugins`
+  - update `version.java` `1.6` -> `1.8`
+  - update URLs to fit with new repo location
+
+- README.md:
+  - add URLs for build badges
+
+- UnleashGitMerger.java:
+  - fix JavaDoc warnings
+
+
+<!--
+## []
+
+### NeverReleased
+- This is just a dummy placeholder to make the parser of GHCICD/release-notes-from-changelog@v1 happy!
+-->
+
+[Unreleased]: https://github.com/mavenplugins/unleash-scm-provider-git/compare/v2.3.0..HEAD
+[2.3.0]: https://github.com/mavenplugins/unleash-scm-provider-git/releases/tag/v2.3.0
diff --git a/README.md b/README.md
@@ -1 +1,4 @@
 # Git SCM Provider for the Unleash Maven Plugin
+[![Eclipse Public License](https://img.shields.io/github/license/mavenplugins/unleash-scm-provider-git?label=License)](./LICENSE)
+[![Maven Central](https://img.shields.io/maven-central/v/io.github.mavenplugins/unleash-scm-provider-git.svg?label=Maven%20Central)](https://search.maven.org/artifact/io.github.mavenplugins/unleash-scm-provider-git)
+[![CI](https://github.com/mavenplugins/unleash-scm-provider-git/actions/workflows/build_and_deploy.yml/badge.svg)](https://github.com/mavenplugins/unleash-scm-provider-git/actions/workflows/build_and_deploy.yml)
diff --git a/pom.xml b/pom.xml
@@ -2,18 +2,17 @@
   <modelVersion>4.0.0</modelVersion>
 
   <parent>
-    <groupId>com.itemis</groupId>
+    <groupId>io.github.mavenplugins</groupId>
     <artifactId>org-parent</artifactId>
     <version>1</version>
   </parent>
 
-  <groupId>com.itemis.maven.plugins</groupId>
   <artifactId>unleash-scm-provider-git</artifactId>
   <version>2.3.1-SNAPSHOT</version>
 
   <name>Unleash SCM Provider Git</name>
   <description>The Git SCM provider for the Unleash Maven Plugin.</description>
-  <url>https://github.com/shillner/unleash-scm-provider-git</url>
+  <url>https://github.com/mavenplugins/unleash-scm-provider-git</url>
   <inceptionYear>2016</inceptionYear>
 
   <developers>
@@ -24,21 +23,25 @@
       <organizationUrl>https://itemis.com/</organizationUrl>
       <timezone>1</timezone>
     </developer>
+    <developer>
+      <id>Developers</id>
+      <url>https://github.com/mavenplugins/unleash-scm-provider-git/graphs/contributors</url>
+    </developer>
   </developers>
 
   <scm>
-    <connection>scm:git:https://github.com/shillner/unleash-scm-provider-git.git</connection>
-    <url>https://github.com/shillner/unleash-scm-provider-git</url>
+    <connection>scm:git:https://github.com/mavenplugins/unleash-scm-provider-git.git</connection>
+    <url>https://github.com/mavenplugins/unleash-scm-provider-git</url>
     <tag>HEAD</tag>
   </scm>
 
   <issueManagement>
     <system>GitHub</system>
-    <url>https://github.com/shillner/unleash-scm-provider-git/issues</url>
+    <url>https://github.com/mavenplugins/unleash-scm-provider-git/issues</url>
   </issueManagement>
 
   <properties>
-    <version.java>1.6</version.java>
+    <version.java>1.8</version.java>
     <version.jgit>5.0.2.201807311906-r</version.jgit>
     <version.jsch>0.1.54</version.jsch>
     <version.jsch-agentproxy>0.0.9</version.jsch-agentproxy>
@@ -98,7 +101,7 @@
       <scope>test</scope>
     </dependency>
     <dependency>
-      <groupId>com.itemis.maven.plugins</groupId>
+      <groupId>io.github.mavenplugins</groupId>
       <artifactId>unleash-scm-provider-api</artifactId>
       <version>${version.unleash-scm-provider-api}</version>
     </dependency>
@@ -118,4 +121,5 @@
       </plugins>
     </pluginManagement>
   </build>
+
 </project>
diff --git a/src/main/java/com/itemis/maven/plugins/unleash/scm/providers/merge/UnleashGitMerger.java b/src/main/java/com/itemis/maven/plugins/unleash/scm/providers/merge/UnleashGitMerger.java
@@ -275,8 +275,9 @@ public class UnleashGitMerger extends ResolveMerger {
   private MergeClient mergeClient;
 
   /**
-   * @param local
-   * @param inCore
+   * @param local       the local {@link Repository}
+   * @param inCore      see {@link UnleashGitMerger#inCore}
+   * @param mergeClient the {@link MergeClient implementation}
    */
   protected UnleashGitMerger(Repository local, boolean inCore, MergeClient mergeClient) {
     super(local);
@@ -296,7 +297,8 @@ protected UnleashGitMerger(Repository local, boolean inCore, MergeClient mergeCl
   }
 
   /**
-   * @param local
+   * @param local       the local {@link Repository}
+   * @param mergeClient the {@link MergeClient implementation}
    */
   protected UnleashGitMerger(Repository local, MergeClient mergeClient) {
     this(local, false, mergeClient);
@@ -343,9 +345,9 @@ private void checkout() throws NoWorkTreeException, IOException {
    * contained only stage 0. In case if inCore operation just clear the
    * history of modified files.
    *
-   * @throws IOException
-   * @throws CorruptObjectException
-   * @throws NoWorkTreeException
+   * @throws IOException            by org.eclipse.jgit
+   * @throws CorruptObjectException by org.eclipse.jgit
+   * @throws NoWorkTreeException    by org.eclipse.jgit
    * @since 3.4
    */
   @Override
@@ -450,10 +452,10 @@ private DirCacheEntry keep(DirCacheEntry e) {
    * @return <code>false</code> if the merge will fail because the index entry
    *         didn't match ours or the working-dir file was dirty and a
    *         conflict occurred
-   * @throws org.eclipse.jgit.errors.MissingObjectException
-   * @throws org.eclipse.jgit.errors.IncorrectObjectTypeException
-   * @throws org.eclipse.jgit.errors.CorruptObjectException
-   * @throws java.io.IOException
+   * @throws org.eclipse.jgit.errors.MissingObjectException       on appropriate git issue
+   * @throws org.eclipse.jgit.errors.IncorrectObjectTypeException on appropriate git issue
+   * @throws org.eclipse.jgit.errors.CorruptObjectException       on appropriate git issue
+   * @throws java.io.IOException                                  on appropriate git issue
    * @since 4.9
    */
   @Override
@@ -990,11 +992,10 @@ public void setWorkingTreeIterator(WorkingTreeIterator workingTreeIterator) {
   /**
    * The resolve conflict way of three way merging
    *
-   * @param baseTree
-   * @param headTree
-   * @param mergeTree
-   * @param ignoreConflicts
-   *                          Controls what to do in case a content-merge is done and a
+   * @param baseTree        the base tree
+   * @param headTree        the head tree
+   * @param mergeTree       the merge tree
+   * @param ignoreConflicts Controls what to do in case a content-merge is done and a
    *                          conflict is detected. The default setting for this should be
    *                          <code>false</code>. In this case the working tree file is
    *                          filled with new content (containing conflict markers) and the
@@ -1013,7 +1014,7 @@ public void setWorkingTreeIterator(WorkingTreeIterator workingTreeIterator) {
    *                          merge bases we don't want to deal with content-merge
    *                          conflicts.
    * @return whether the trees merged cleanly
-   * @throws IOException
+   * @throws IOException on appropriate git issue
    * @since 3.5
    */
   @Override
@@ -1077,7 +1078,7 @@ protected boolean mergeTrees(AbstractTreeIterator baseTree, RevTree headTree, Re
    *                          see
    *                          {@link UnleashGitMerger#mergeTrees(AbstractTreeIterator, RevTree, RevTree, boolean)}
    * @return Whether the trees merged cleanly.
-   * @throws IOException
+   * @throws IOException on appropriate git issue
    * @since 3.5
    */
   @Override