Issue #40: Rebrand Codebase from Sentry Software to MetricsHub

.github/workflows/build.yml

@@ -15,11 +15,11 @@ on:
         description: Open SSH session in the runner
         required: false
         default: false
-        
+
 jobs:
   build:
-    uses: sentrysoftware/workflows/.github/workflows/maven-build.yml@v3
+    uses: metricshub/workflows/.github/workflows/maven-build.yml@v2
     with:
       jdkVersion: "17"
       debug: ${{ github.event_name == 'workflow_dispatch' && inputs.debug }}
-      ssh: ${{ github.event_name == 'workflow_dispatch' && inputs.ssh }}
+      ssh: ${{ github.event_name == 'workflow_dispatch' && inputs.ssh }}

.github/workflows/deploy.yml

@@ -10,7 +10,7 @@ on:
 
 jobs:
   deploy:
-    uses: sentrysoftware/workflows/.github/workflows/maven-central-deploy.yml@v3
+    uses: metricshub/workflows/.github/workflows/maven-central-deploy.yml@v2
     with:
       jdkVersion: "17"
     secrets: inherit

.github/workflows/release.yml

@@ -18,7 +18,7 @@ on:
 
 jobs:
   release:
-    uses: sentrysoftware/workflows/.github/workflows/maven-central-release.yml@v3
+    uses: metricshub/workflows/.github/workflows/maven-central-release.yml@v2
     with:
       releaseVersion: ${{ inputs.releaseVersion }}
       developmentVersion: ${{ inputs.developmentVersion }}

README.md

@@ -1,13 +1,13 @@
 # SSH Java Client
 
-![GitHub release (with filter)](https://img.shields.io/github/v/release/sentrysoftware/ssh)
-![Build](https://img.shields.io/github/actions/workflow/status/sentrysoftware/ssh/deploy.yml)
-![GitHub top language](https://img.shields.io/github/languages/top/sentrysoftware/ssh)
-![License](https://img.shields.io/github/license/sentrysoftware/ssh)
+![GitHub release (with filter)](https://img.shields.io/github/v/release/metricshub/ssh-java)
+![Build](https://img.shields.io/github/actions/workflow/status/metricshub/ssh-java/deploy.yml)
+![GitHub top language](https://img.shields.io/github/languages/top/metricshub/ssh-java)
+![License](https://img.shields.io/github/license/metricshub/ssh-java)
 
 The SSH Java client is a library that allows to execute commands using SSH protocol in distant hosts.
 
-See **[Project Documentation](https://sentrysoftware.org/ssh)** and the [Javadoc](https://sentrysoftware.org/ssh/apidocs) for more information on how to use this library in your code.
+See **[Project Documentation](https://metricshub.org/ssh-java)** and the [Javadoc](https://metricshub.org/ssh-java/apidocs) for more information on how to use this library in your code.
 
 ## Build instructions
 

checkstyle.origin.xml

@@ -0,0 +1,222 @@
+<?xml version="1.0"?>
+<!DOCTYPE module PUBLIC
+    "-//Puppy Crawl//DTD Check Configuration 1.2//EN"
+    "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
+
+<!--
+
+	Custom Checkstyle configuration that checks coding conventions,
+	roughly following the SUN coding conventions from:
+
+	- the Java Language Specification at
+	  http://java.sun.com/docs/books/jls/second_edition/html/index.html
+
+	- the Sun Code Conventions at http://java.sun.com/docs/codeconv/
+
+	- the Javadoc guidelines at
+	  http://java.sun.com/j2se/javadoc/writingdoccomments/index.html
+
+	- the JDK Api documentation http://java.sun.com/j2se/docs/api/index.html
+
+	- some best practices
+
+	Checkstyle is very configurable. Be sure to read the documentation at
+	http://checkstyle.sf.net (or in your downloaded distribution).
+
+	Most Checks are configurable, be sure to consult the documentation.
+
+	To completely disable a check, just comment it out or delete it.
+
+	Finally, it is worth reading the documentation.
+
+-->
+
+<module name="Checker">
+	<!--
+		If you set the basedir property below, then all reported file
+		names will be relative to the specified directory. See
+		http://checkstyle.sourceforge.net/5.x/config.html#Checker
+
+		<property name="basedir" value="${basedir}"/>
+	-->
+
+	<!-- Checks that a package-info.java file exists for each package.   -->
+	<!-- See http://checkstyle.sf.net/config_javadoc.html#JavadocPackage -->
+	<!--<module name="JavadocPackage"/>-->
+
+	<!-- Checks whether files end with a new line.                        -->
+	<!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile -->
+	<!----><module name="NewlineAtEndOfFile"/>
+
+	<!-- Checks that property files contain the same keys.         -->
+	<!-- See http://checkstyle.sf.net/config_misc.html#Translation -->
+	<module name="Translation"/>
+
+	<!-- Checks for Size Violations.                    -->
+	<!-- See http://checkstyle.sf.net/config_sizes.html -->
+	<module name="FileLength"/>
+
+	<!-- Checks for tab indentation -->
+	<module name="RegexpSingleline">
+		<property name="format" value="^\s* +\s*[^*]" />
+		<property name="message" value="Indentation must use tab characters" />
+	</module>
+
+	<!-- Miscellaneous other checks.                   -->
+	<!-- See http://checkstyle.sf.net/config_misc.html -->
+	<module name="RegexpSingleline">
+		<property name="format" value="\s+$"/>
+		<property name="minimum" value="0"/>
+		<property name="maximum" value="0"/>
+		<property name="message" value="Line has trailing spaces."/>
+	</module>
+
+	<module name="TreeWalker">
+
+		<!-- Checks for Javadoc comments.                     -->
+		<!-- See http://checkstyle.sf.net/config_javadoc.html -->
+		<!--<module name="JavadocMethod">
+			<property name="scope" value="package"/>
+		</module>
+		<module name="JavadocType">
+			<property name="scope" value="package"/>
+			<property name="authorFormat" value=".*"/>
+		</module>
+		<module name="JavadocVariable">
+			<property name="scope" value="package"/>
+		</module>
+		<module name="JavadocStyle">
+			<property name="checkEmptyJavadoc" value="true"/>
+		</module>-->
+
+
+		<!-- Checks for Naming Conventions.                  -->
+		<!-- See http://checkstyle.sf.net/config_naming.html -->
+		<module name="ConstantName"/>
+		<module name="LocalFinalVariableName"/>
+		<module name="LocalVariableName"/>
+		<module name="MemberName"/>
+		<module name="MethodName"/>
+		<module name="PackageName"/>
+		<module name="ParameterName"/>
+		<module name="StaticVariableName"/>
+		<module name="TypeName"/>
+
+
+		<!-- Checks for Headers                              -->
+		<!-- See http://checkstyle.sf.net/config_header.html -->
+		<!--<module name="Header">-->
+		<!-- The follow property value demonstrates the ability        -->
+		<!-- to have access to ANT configuration. In this case it uses -->
+		<!-- the ${basedir} property to allow Checkstyle to be run     -->
+		<!-- from any directory within a project. See property         -->
+		<!-- expansion,                                                -->
+		<!-- http://checkstyle.sf.net/config.html#configuration        -->
+		<!-- <property                                                 -->
+		<!--     name="headerFile"                                     -->
+		<!--     value="${basedir}/java.header"/>                      -->
+		<!--</module>-->
+
+		<!-- Following interprets the header file as regular expressions. -->
+		<!--<module name="RegexpHeader"/>-->
+
+
+		<!-- Checks for imports                              -->
+		<!-- See http://checkstyle.sf.net/config_import.html -->
+		<module name="AvoidStarImport"/>
+		<module name="IllegalImport"/> <!-- defaults to sun.* packages -->
+		<module name="RedundantImport"/>
+		<module name="UnusedImports"/>
+
+
+		<!-- Checks for Size Violations.                    -->
+		<!-- See http://checkstyle.sf.net/config_sizes.html -->
+		<!--<module name="LineLength"/>-->
+		<module name="MethodLength"/>
+		<module name="ParameterNumber">
+			<property name="tokens" value="METHOD_DEF"/>
+		</module>
+
+
+		<!-- Checks for whitespace                               -->
+		<!-- See http://checkstyle.sf.net/config_whitespace.html -->
+		<module name="EmptyForIteratorPad"/>
+		<module name="GenericWhitespace"/>
+		<module name="MethodParamPad"/>
+		<module name="NoWhitespaceAfter"/>
+		<module name="NoWhitespaceBefore"/>
+		<module name="OperatorWrap"/>
+		<!--<module name="ParenPad"/>-->
+		<module name="TypecastParenPad"/>
+		<module name="WhitespaceAfter">
+			<property name="tokens" value="COMMA, SEMI"/>
+		</module>
+		<module name="WhitespaceAround">
+			<property name="tokens" value="ASSIGN, BAND_ASSIGN, BOR_ASSIGN, BSR_ASSIGN, BXOR_ASSIGN, COLON, DIV_ASSIGN, EQUAL, GE, GT, LE, LITERAL_RETURN, LT, MINUS_ASSIGN, MOD_ASSIGN, NOT_EQUAL, PLUS_ASSIGN, QUESTION, SL_ASSIGN, SR_ASSIGN, STAR_ASSIGN"/>
+		</module>
+
+
+		<!-- Modifier Checks                                    -->
+		<!-- See http://checkstyle.sf.net/config_modifiers.html -->
+		<module name="ModifierOrder"/>
+		<module name="RedundantModifier"/>
+
+
+		<!-- Checks for blocks. You know, those {}'s         -->
+		<!-- See http://checkstyle.sf.net/config_blocks.html -->
+		<module name="AvoidNestedBlocks"/>
+		<!--<module name="EmptyBlock"/>-->
+		<module name="LeftCurly">
+			<property name="option" value="nlow"/>
+		</module>
+		<module name="NeedBraces"/>
+		<!--<module name="RightCurly">
+			<property name="option" value="alone"/>
+		</module>-->
+
+
+		<!-- Checks for common coding problems               -->
+		<!-- See http://checkstyle.sf.net/config_coding.html -->
+		<!--<module name="AvoidInlineConditionals"/>-->
+		<module name="EmptyStatement"/>
+		<module name="EqualsHashCode"/>
+		<module name="HiddenField">
+			<property name="ignoreConstructorParameter" value="true"/>
+			<property name="ignoreSetter" value="true"/>
+		</module>
+		<module name="IllegalInstantiation"/>
+		<module name="InnerAssignment"/>
+		<!--<module name="MagicNumber"/>-->
+		<module name="MissingSwitchDefault"/>
+		<module name="SimplifyBooleanExpression"/>
+		<module name="SimplifyBooleanReturn"/>
+
+		<!-- Checks for class design                         -->
+		<!-- See http://checkstyle.sf.net/config_design.html -->
+		<!--<module name="DesignForExtension"/>-->
+		<module name="FinalClass"/>
+		<module name="HideUtilityClassConstructor"/>
+		<module name="InterfaceIsType"/>
+		<module name="VisibilityModifier"/>
+
+
+		<!-- Miscellaneous other checks.                   -->
+		<!-- See http://checkstyle.sf.net/config_misc.html -->
+		<module name="ArrayTypeStyle"/>
+		<module name="FinalParameters"/>
+		<module name="TodoComment">
+			<property name="format" value="FIXME"/>
+		</module>
+		<module name="TodoComment">
+			<property name="format" value="TODO"/>
+			<property name="severity" value="warning"/>
+		</module>
+		<module name="TodoComment">
+			<property name="format" value="XXX"/>
+			<property name="severity" value="warning"/>
+		</module>
+		<module name="UpperEll"/>
+
+	</module>
+
+</module>