FEAT[#41] - Prepare release documentation

EmbedITCZ · Nov 8, 2018 · bd3d524 · bd3d524
1 parent df8ebbf
commit bd3d524
Show file tree

Hide file tree

Showing 5 changed files with 76 additions and 12 deletions.
diff --git a/.nojekyll b/.nojekyll
diff --git a/README.md b/README.md
@@ -24,3 +24,6 @@ Recommended set of plugins:
 ## modules
 - [core](jbehave-support-core/README.md) - details about integration and usage 
 
+>
+> The release process is done by maven and for the setup, you should follow [the release document](docs/Release.md)
+> 
diff --git a/docs/Release.md b/docs/Release.md
@@ -0,0 +1,40 @@
+# Configuration for release to maven central
+
+Register at [sonatype jira](https://issues.sonatype.org) - credential should be used in ossrh server section.
+Create the task in sonatype's jira for getting permission to deploy. 
+Generate gpg key for signing artifacts. You can use steps from [sonatype blog](https://blog.sonatype.com/2010/01/how-to-generate-pgp-signatures-with-maven/) - use only steps for generating keys and registering to the central server - rest should be already configured.
+
+Fragment from settings.xml (replace variables with values above):
+```xml
+  <servers>
+    <server>
+      <id>ossrh</id>
+      <username>${ossrh.username}</username>
+      <password>${ossrh.password}</password>
+    </server>
+  </servers>
+
+  <profiles>
+    <profile>
+      <id>ossrh</id>
+      <activation>
+        <activeByDefault>true</activeByDefault>
+      </activation>
+      <properties>
+        <gpg.executable>gpg</gpg.executable>
+        <gpg.passphrase>${gpg password}</gpg.passphrase>
+      </properties>
+    </profile>
+  </profiles>
+```
+
+Then you can simply run the command below and snapshot are going to be deployed to ossr sonatype repository. 
+```bash
+mvn clean deploy -Prelease
+```
+
+Release is performed by two commands
+```bash
+mvn release:clean release:prepare -Prelease
+mvn release:perform -Prelease
+```
diff --git a/index.html b/index.html
@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>Document</title>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+  <meta name="description" content="Description">
+  <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
+  <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
+</head>
+<body>
+  <div id="app"></div>
+  <script>
+    window.$docsify = {
+      name: 'JBehave Support',
+      repo: 'embeditcz/jbehave-support',
+    }
+  </script>
+  <script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
+</body>
+</html>
diff --git a/jbehave-support-core/README.md b/jbehave-support-core/README.md
@@ -1,14 +1,14 @@
 # jBehave core support
 Core jBehave support. 
-- [Integration test](docs/IntegrationTest.md)  
-- [Test context](docs/Test-context.md)  
-- [Expression commands](docs/Expression-commands.md) 
-- [Web service steps](docs/Web-service.md)
-- [REST API steps](docs/Rest-api.md)
-- [JMS steps](docs/Jms.md)
-- [SQL steps](docs/Sql-steps.md)
-- [SSH steps](docs/Ssh.md)
-- [Web testing](docs/Web-testing.md)
-- [General info](docs/General.md)
-- [Reporting](docs/Reporting.md)
-- [Filtering](docs/Filtering.md)
+- [Integration test](/jbehave-support-core/docs/IntegrationTest.md)  
+- [Test context](/jbehave-support-core/docs/Test-context.md)  
+- [Expression commands](/jbehave-support-core/docs/Expression-commands.md) 
+- [Web service steps](/jbehave-support-core/docs/Web-service.md)
+- [REST API steps](/jbehave-support-core/docs/Rest-api.md)
+- [JMS steps](/jbehave-support-core/docs/Jms.md)
+- [SQL steps](/jbehave-support-core/docs/Sql-steps.md)
+- [SSH steps](/jbehave-support-core/docs/Ssh.md)
+- [Web testing](/jbehave-support-core/docs/Web-testing.md)
+- [General info](/jbehave-support-core/docs/General.md)
+- [Reporting](/jbehave-support-core/docs/Reporting.md)
+- [Filtering](/jbehave-support-core/docs/Filtering.md)