Release2.4 (#3)

* added features * fixes for deployment to maven central * update readme
factionsecurity · Mar 2, 2024 · c371db6 · c371db6
1 parent 8558bb9
commit c371db6
Show file tree

Hide file tree

Showing 36 changed files with 386 additions and 398 deletions.
diff --git a/.classpath b/.classpath
@@ -1,7 +1,18 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <classpath>
-	<classpathentry kind="src" path="src/main/java"/>
-	<classpathentry kind="src" output="target/test-classes" path="src/test/java"/>
+	<classpathentry kind="src" output="target/classes" path="src/main/java">
+		<attributes>
+			<attribute name="optional" value="true"/>
+			<attribute name="maven.pomderived" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry kind="src" output="target/test-classes" path="src/test/java">
+		<attributes>
+			<attribute name="optional" value="true"/>
+			<attribute name="maven.pomderived" value="true"/>
+			<attribute name="test" value="true"/>
+		</attributes>
+	</classpathentry>
 	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.8">
 		<attributes>
 			<attribute name="maven.pomderived" value="true"/>
@@ -14,5 +25,18 @@
 		</attributes>
 	</classpathentry>
 	<classpathentry kind="con" path="org.eclipse.jdt.junit.JUNIT_CONTAINER/5"/>
+	<classpathentry excluding="**" kind="src" output="target/classes" path="src/main/resources">
+		<attributes>
+			<attribute name="maven.pomderived" value="true"/>
+			<attribute name="optional" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry excluding="**" kind="src" output="target/test-classes" path="src/test/resources">
+		<attributes>
+			<attribute name="maven.pomderived" value="true"/>
+			<attribute name="test" value="true"/>
+			<attribute name="optional" value="true"/>
+		</attributes>
+	</classpathentry>
 	<classpathentry kind="output" path="target/classes"/>
 </classpath>
diff --git a/.settings/org.eclipse.wst.common.component b/.settings/org.eclipse.wst.common.component
@@ -1,9 +1,12 @@
 <?xml version="1.0" encoding="UTF-8"?><project-modules id="moduleCoreId" project-version="1.5.0">
-
+
+
     <wb-module deploy-name="FactionExtender">
+
         <wb-resource deploy-path="/" source-path="/src/main/java"/>
-        <wb-resource deploy-path="/" source-path="/src/test/java"/>
-
-    </wb-module>
+
 
+    </wb-module>
+
+
 </project-modules>
diff --git a/README.md b/README.md
@@ -1,46 +1,14 @@
 # FactionExtender
 
-This Java Library allows you to write extensions for FuseSoft Faction. Once a module is created it only needs to be placed in /opt/faction/modules/ directory along with any library dependencies. 
+This Java Library allows you to write extensions for Faction. To create an extension you need to add this to your pom but ensure you are using the latest version.
 
-Tutorial can be found here:
+[Click here to see the latest published versions](https://central.sonatype.com/artifact/com.factionsecurity/faction-extender)
 
-https://docs.factionsecurity.com
-### To Build a Faction extension you need to follow these steps:
-1. Update your `~/.m2/settings.xml` file to include the following:
-   _this will allow `maven` to have access to this git bug repo_
-```
-<settings>
-    <activeProfiles>
-    <activeProfile>github</activeProfile>
-  </activeProfiles>
-   <profiles>
-    <profile>
-      <id>github</id>
-      <repositories>
-        <repository>
-          <id>central</id>
-          <url>https://repo1.maven.org/maven2</url>
-        </repository>
-        <repository>
-          <id>github</id>
-          <url>https://maven.pkg.github.com/factionsecurity/FactionExtender</url>
-          <snapshots>
-            <enabled>true</enabled>
-          </snapshots>
-        </repository>
-      </repositories>
-    </profile>
-  </profiles>
-</settings>
-```
-2. Add the folowing lines to your project dependencies pom.xml.
 ```
 <dependency>
-  <groupId>FactionSecurity</groupId>
-  <artifactId>faction-extender</artifactId>
-  <version>1.9</version>
+    <groupId>com.factionsecurity</groupId>
+    <artifactId>faction-extender</artifactId>
+    <version>2.5</version>
 </dependency>
 ```
 
-Thanks it! You can now start developing your own plugins. More information about writing a Faction Plugin Can be found here: https://www.fusesoftsecurity.com/manual/faction-extension-api/
-
diff --git a/pom.xml b/pom.xml
@@ -1,8 +1,10 @@
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 	<modelVersion>4.0.0</modelVersion>
-	<groupId>FactionSecurity</groupId>
+	<groupId>com.factionsecurity</groupId>
 	<artifactId>faction-extender</artifactId>
-	<version>2.4-SNAPSHOT</version>
+	<version>2.5</version>
 	<packaging>jar</packaging>
 	<name>Faction Extender API</name>
 	<description>API to interfaces for building extensions for Faction.</description>
@@ -14,9 +16,18 @@
 			<distribution>repo</distribution>
 		</license>
 	</licenses>
+	<developers>
+		<developer>
+			<name>Josh Summitt</name>
+			<email>[email protected]</email>
+			<organization>Faction Security</organization>
+			<organizationUrl>https://www.factionsecurity.com</organizationUrl>
+		</developer>
+	</developers>
 	<scm>
 		<url>https://github.com/factionsecurity/FactionExtender.git</url>
-		<connection>scm:git:https://github.com/factionsecurity/FactionExtender.git</connection>
+		<connection>
+			scm:git:https://github.com/factionsecurity/FactionExtender.git</connection>
 		<developerConnection>
 			scm:git:https://github.com/factionsecurity/FactionExtender.git</developerConnection>
 		<tag>2.2</tag>
@@ -26,17 +37,71 @@
 		<project.scm.id>github</project.scm.id>
 		<github.global.server>github</github.global.server>
 	</properties>
-	<distributionManagement>
-		<repository>
-			<id>github</id>
-			<name>Faction Extender</name>
-			<url>https://maven.pkg.github.com/factionsecurity/FactionExtender</url>
-		</repository>
-	</distributionManagement>
 	<build>
 		<sourceDirectory>src/main/java</sourceDirectory>
-	    <testSourceDirectory>src/test/java</testSourceDirectory>	
+		<testSourceDirectory>src/test/java</testSourceDirectory>
 		<plugins>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-source-plugin</artifactId>
+				<version>3.3.0</version>
+				<executions>
+					<execution>
+						<id>attach-sources</id>
+						<goals>
+							<goal>jar-no-fork</goal>
+						</goals>
+					</execution>
+				</executions>
+			</plugin>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-javadoc-plugin</artifactId>
+				<executions>
+					<execution>
+						<id>attach-javadocs</id>
+						<goals>
+							<goal>jar</goal>
+						</goals>
+					</execution>
+				</executions>
+			</plugin>
+			<plugin>
+				<groupId>net.ju-n.maven.plugins</groupId>
+				<artifactId>checksum-maven-plugin</artifactId>
+				<version>1.2</version>
+				<executions>
+					<execution>
+						<goals>
+							<goal>artifacts</goal>
+						</goals>
+					</execution>
+				</executions>
+			</plugin>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-gpg-plugin</artifactId>
+				<version>3.1.0</version>
+				<executions>
+					<execution>
+						<id>sign-artifacts</id>
+						<phase>verify</phase>
+						<goals>
+							<goal>sign</goal>
+						</goals>
+					</execution>
+				</executions>
+			</plugin>
+			<plugin>
+				<groupId>org.sonatype.central</groupId>
+				<artifactId>central-publishing-maven-plugin</artifactId>
+				<version>0.3.0</version>
+				<extensions>true</extensions>
+				<configuration>
+					<publishingServerId>sonatype</publishingServerId>
+					<tokenAuth>true</tokenAuth>
+				</configuration>
+			</plugin>
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-release-plugin</artifactId>

diff --git a/pom.xml.releaseBackup b/pom.xml.releaseBackup
@@ -2,7 +2,7 @@
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>FactionSecurity</groupId>
 	<artifactId>faction-extender</artifactId>
-	<version>2.2-SNAPSHOT</version>
+	<version>2.3-SNAPSHOT</version>
 	<packaging>jar</packaging>
 	<name>Faction Extender API</name>
 	<description>API to interfaces for building extensions for Faction.</description>

diff --git a/release.properties b/release.properties
@@ -1,11 +1,11 @@
 #release configuration
-#Sun Jan 14 16:37:39 CST 2024
-completedPhase=run-preparation-goals
+#Sun Jan 14 16:44:12 CST 2024
+completedPhase=end-release
 exec.additionalArguments=-Dmaven.javadoc.skip\=true -Dmaven.test.skipTests\=true -Dmaven.test.skip\=true -P github
 exec.snapshotReleasePluginAllowed=false
 preparationGoals=clean verify
-project.dev.FactionSecurity\:faction-extender=2.3-SNAPSHOT
-project.rel.FactionSecurity\:faction-extender=2.2
+project.dev.FactionSecurity\:faction-extender=2.4-SNAPSHOT
+project.rel.FactionSecurity\:faction-extender=2.3
 project.scm.FactionSecurity\:faction-extender.connection=scm\:git\:https\://github.com/factionsecurity/FactionExtender.git
 project.scm.FactionSecurity\:faction-extender.developerConnection=scm\:git\:https\://github.com/factionsecurity/FactionExtender.git
 project.scm.FactionSecurity\:faction-extender.id=github
@@ -16,7 +16,7 @@ pushChanges=true
 remoteTagging=true
 scm.commentPrefix=[maven-release-plugin] 
 scm.id=github
-scm.tag=2.2
+scm.tag=2.3
 scm.tagNameFormat=@{project.version}
 scm.url=scm\:git\:https\://github.com/factionsecurity/FactionExtender.git
 scm.username=summitt