Setup and description for the release deployment

README.md

@@ -1,7 +1,19 @@
+[![Build Xtext2Langium](https://github.com/TypeFox/xtext2langium/actions/workflows/main.yml/badge.svg)](https://github.com/TypeFox/xtext2langium/actions/workflows/main.yml)
+
 # xtext2langium
 
 #### Generator Frgment for the MWE2 Workflow: 
 
 Update site: https://typefox.github.io/xtext2langium/download/updates/main/
 
-Maven Snapshot: https://oss.sonatype.org/content/repositories/snapshots/
+
+Maven: 
+```xml
+<dependency>
+    <groupId>io.typefox.xtext2langium</groupId>
+    <artifactId>xtext2langium</artifactId>
+    <version>0.1.0</version>
+</dependency>
+```
+Gradle: `io.typefox.xtext2langium:xtext2langium:0.1.0`
+

RELEASE.md

@@ -0,0 +1,43 @@
+#### Deploy locally
+##### Setup your local settings.xml
+
+```
+<servers>
+    <server>
+        <id>OSSRH</id>
+        <username>USER_NAME</username>
+        <password>PASSWORD</password>
+    </server>
+</servers>
+<!-- Only needed for release deployment --> 
+<profiles>
+    <profile>
+        <id>OSSRH</id>
+        <activation>
+            <activeByDefault>true</activeByDefault>
+        </activation>
+        <properties>
+            <gpg.executable>/usr/local/bin/gpg</gpg.executable>
+            <gpg.keyname>KEY_ID</gpg.keyname>
+            <gpg.passphrase>KEY_PASSWORD</gpg.passphrase>
+        </properties>
+    </profile>
+</profiles>
+```
+
+##### Deploy a SNAPSHOT
+
+Run `mvn clean deploy`
+
+_Note: Current setup requires Java11_
+
+##### Deploy a RELEASE
+
+Set the new version
+`mvn org.eclipse.tycho:tycho-versions-plugin:2.7.5:set-version -DnewVersion=0.1.0`
+
+Start deployment
+`mvn clean deploy -P release`
+
+Check the status of the staged repository and release
+[oss.sonatype.org](https://oss.sonatype.org/index.html)

pom.xml

@@ -39,28 +39,6 @@
 					</execution>
 				</executions>
 			</plugin>
-			<plugin>
-				<groupId>org.apache.maven.plugins</groupId>
-				<artifactId>maven-javadoc-plugin</artifactId>
-				<version>2.9.1</version>
-				<configuration>
-					<nohelp>true</nohelp>
-					<aggregate>true</aggregate>
-					<charset>UTF-8</charset>
-					<encoding>UTF-8</encoding>
-					<docencoding>UTF-8</docencoding>
-					<additionalparam>-Xdoclint:none</additionalparam>
-					<detectJavaApiLink>false</detectJavaApiLink>
-				</configuration>
-				<executions>
-					<execution>
-						<phase>package</phase>
-						<goals>
-							<goal>jar</goal>
-						</goals>
-					</execution>
-				</executions>
-			</plugin>
 			<plugin>
 				<groupId>org.eclipse.tycho</groupId>
 				<artifactId>tycho-p2-plugin</artifactId>
@@ -111,27 +89,6 @@
 					</environments>
 				</configuration>
 			</plugin>
-			<plugin>
-				<groupId>org.apache.maven.plugins</groupId>
-				<artifactId>maven-gpg-plugin</artifactId>
-				<version>1.6</version>
-				<executions>
-					<execution>
-						<id>sign-artifacts</id>
-						<phase>verify</phase>
-						<goals>
-							<goal>sign</goal>
-						</goals>
-						<configuration>
-							<skip>true</skip>
-							<gpgArguments>
-								<arg>--pinentry-mode</arg>
-								<arg>loopback</arg>
-							</gpgArguments>
-						</configuration>
-					</execution>
-				</executions>
-			</plugin>
 			<plugin>
 				<artifactId>maven-deploy-plugin</artifactId>
 			</plugin>
@@ -154,33 +111,85 @@
 			</plugins>
 		</pluginManagement>
 	</build>
+	<profiles>
+		<profile>
+			<id>release</id>
+			<build>
+				<plugins>
+					<plugin>
+						<groupId>org.apache.maven.plugins</groupId>
+						<artifactId>maven-javadoc-plugin</artifactId>
+						<version>2.9.1</version>
+						<configuration>
+							<nohelp>true</nohelp>
+							<aggregate>true</aggregate>
+							<charset>UTF-8</charset>
+							<encoding>UTF-8</encoding>
+							<docencoding>UTF-8</docencoding>
+							<additionalparam>-Xdoclint:none</additionalparam>
+							<detectJavaApiLink>false</detectJavaApiLink>
+						</configuration>
+						<executions>
+							<execution>
+								<phase>package</phase>
+								<goals>
+									<goal>jar</goal>
+								</goals>
+							</execution>
+						</executions>
+					</plugin>
+					<plugin>
+						<groupId>org.apache.maven.plugins</groupId>
+						<artifactId>maven-gpg-plugin</artifactId>
+						<version>1.6</version>
+						<executions>
+							<execution>
+								<id>sign-artifacts</id>
+								<phase>verify</phase>
+								<goals>
+									<goal>sign</goal>
+								</goals>
+								<configuration>
+									<gpgArguments>
+										<arg>--pinentry-mode</arg>
+										<arg>loopback</arg>
+									</gpgArguments>
+								</configuration>
+							</execution>
+						</executions>
+					</plugin>
+				</plugins>
+			</build>
+		</profile>
+	</profiles>
+
 	<name>Xtext to Langium Generator Fragment</name>
 	<description>Provides a generator Fragment for MWE2 Workflow to convert existing Xtext Grammar to Langium.</description>
 	<url>https://github.com/TypeFox/xtext2langium</url>
 	<licenses>
 		<license>
 			<name>MIT License</name>
-			<url>http://www.opensource.org/licenses/mit-license.php</url>
+			<url>https://www.opensource.org/licenses/mit-license.php</url>
 		</license>
 	</licenses>
 	<developers>
 		<developer>
 			<name>Dennis Huebner</name>
 			<email>[email protected]</email>
 			<organization>TypeFox GmbH</organization>
-			<organizationUrl>http://www.typefox.io</organizationUrl>
+			<organizationUrl>https://www.typefox.io</organizationUrl>
 		</developer>
 		<developer>
 			<name>Miro Spoenemann</name>
 			<email>[email protected]</email>
 			<organization>TypeFox GmbH</organization>
-			<organizationUrl>http://www.typefox.io</organizationUrl>
+			<organizationUrl>https://www.typefox.io</organizationUrl>
 		</developer>
 	</developers>
 	<scm>
 		<connection>scm:git:git://github.com/TypeFox/xtext2langium.git</connection>
 		<developerConnection>scm:git:ssh://github.com:TypeFox/xtext2langium.git</developerConnection>
-		<url>http://github.com/TypeFox/xtext2langium/tree/main</url>
+		<url>https://github.com/TypeFox/xtext2langium/tree/main</url>
 	</scm>
 	<distributionManagement>
 		<snapshotRepository>