/microdocs-java-plugin

MicroDocs java plugin

Primary LanguageJava

microdocs-java-plugin

This is the Java plugin to publish data to your microdocs server. For more info, see the three READMEs's in the subfolders.

Publishing to Maven Central

Before you can publish, you'll have to do some setup.

  1. Create a sonatype account and create an issue to request access to com.maxxton
  2. Install GnuPG NOTE: at least version 2.1!
  3. Generate key pair by running:
$ gpg --full-generate-key

Choose RSA 2048bit with no expiration. Fill in your name, email, and passphrase. Your key is saved in ~/.gnupg.

  1. Run this to update your secring.gpg:
$ gpg --keyring secring.gpg --export-secret-keys > ~/.gnupg/secring.gpg
  1. Create ~/.gradle/gradle.properties (or C:\\Users\\username\\.gradle\\gradle.properties) with the following properties:
signing.keyId=keyid
signing.password=yourpassword
signing.secretKeyRingFile=C:\\Users\\username\\.gnupg\\secring.gpg

sonatypeUsername=username
sonatypePassword=password

Use gpg --list-secret-keys --keyid-format 0xshort to get your keyId

% gpg --list-secret-keys --keyid-format 0xshort
[keyboxd]
---------
sec   rsa2048/0x1337CAFE 1970-01-01 [SC]
              ^^^^^^^^^^
              ## this bit is what you're looking for.
      1337133713371337133713371337133713371337
uid           [ultimate] Your Name <y.name@maxxton.com>
ssb   rsa2048/0xCAFE1337 1970-01-01 [E]
  1. Publish
$ ./publish

And follow the release and deployment manual Check this link for more info on the signing plugin

Java 8

Checkout the java8 branch for a Java 8 compatible version. The master branch will be based on Java 11, the difference is substantial due to the revised Javadoc API in since Java 9.