Skip to content

Latest commit

 

History

History
211 lines (158 loc) · 7.68 KB

README.md

File metadata and controls

211 lines (158 loc) · 7.68 KB
Raw

gitar

Travis CI Build Status CircleCI

gitar is an object-orient API wrapper on top of JGit.

Usage

gitar is in Maven Central now.

<dependency>
    <groupId>com.gitenter</groupId>
    <artifactId>gitar</artifactId>
    <version>0.0.4-prototype</version>
</dependency>

Development

Prerequisites

Needs to install:

  • Java
  • Maven
  • GnuPG

Needs to have ~/.m2/settings.xml to include OSSRH.

<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 https://maven.apache.org/xsd/settings-1.0.0.xsd">

	<servers>
		<server>
			<id>ossrh</id>
			<username>ozooxo</username>
			<password>...</password>
		</server>
	</servers>

    <profiles>
        <profile>
            <id>ossrh</id>
            <activation>
                <activeByDefault>true</activeByDefault>
            </activation>
            <properties>
                <gpg.executable>gpg</gpg.executable>
                <gpg.passphrase>...</gpg.passphrase>
            </properties>
        </profile>
    </profiles>
</settings>

TODO:

  • Dockerize the development environment.

Compile and Install

This repository should be compiled in Java 10/11 (notice that there's no openjdk-10 but only has openjdk-11 on Ubuntu 18.04). The produced jar is compatible with Java 8+, which makes it Spring compatible (Spring only supports Java 8 yet).

mvn clean install

Deployment

mvn clean deploy

Then the result files will be in /deploy folder. (TODO: It seems I cannot specify repository-id which deployment location I want?)

Maven Central Repository

Useful links
GPG
brew install gnupg

Follow this link. If the gpg server is down, one can list all the available ones using gpg-connect-agent --dirmngr 'keyserver --hosttable', and upload to another one.

$ gpg --list-keys
gpg: checking the trustdb
gpg: marginals needed: 3  completes needed: 1  trust model: pgp
gpg: depth: 0  valid:   1  signed:   0  trust: 0-, 0q, 0n, 0m, 0f, 1u
gpg: next trustdb check due at 2021-03-07
/Users/cynthia/.gnupg/pubring.kbx
---------------------------------
pub   rsa2048 2019-03-08 [SC] [expires: 2021-03-07]
      1F42253DD11F1E7718F35DACC6D9969E8A7371F8
uid           [ultimate] Cong-Xin Qiu <ozooxo@gmail.com>
sub   rsa2048 2019-03-08 [E] [expires: 2021-03-07]

$ gpg-connect-agent --dirmngr 'keyserver --hosttable'
$ gpg --keyserver hkp://pool.sks-keyservers.net --send-keys 1F42253DD11F1E7718F35DACC6D9969E8A7371F8
$ gpg --keyserver hkp://keyserver.timlukas.de --send-keys 1F42253DD11F1E7718F35DACC6D9969E8A7371F8
$ gpg --keyserver hkp://keyserver.timlukas.de --recv-keys 1F42253DD11F1E7718F35DACC6D9969E8A7371F8
$ gpg --keyserver keyserver-prod-fsn1-01.2ndquadrant.it --send-keys 1F42253DD11F1E7718F35DACC6D9969E8A7371F8
$ gpg --keyserver keyserver-prod-fsn1-01.2ndquadrant.it --recv-keys 1F42253DD11F1E7718F35DACC6D9969E8A7371F8
Hosting in/Deploy to OSSRH

Open Source Software Repository Hosting (OSSRH): https://central.sonatype.org/pages/ossrh-guide.html

Generating .asc files is basically

$ cd deploy/com/gitenter/gitar/[version]/
$ gpg -ab gitar-[version].jar
$ gpg -ab gitar-[version].pom
$ gpg -ab gitar-[version]-sources.jar
$ gpg -ab gitar-[version]-javadoc.jar

but it can be automatic using nexus-staging-maven-plugin with maven-gpg-plugin.

Deployment

mvn clean deploy

If got No public key: Key with id: (c6d9969e8a7371f8) was not able to be located on <a href=http://pool.sks-keyservers.net:11371/&gt;http://pool.sks-keyservers.net:11371/&lt;/a&gt;. Upload your public key and try the operation again., that means the public key has not been propagate. Wait several hours and try again.

If got gpg: signing failed: Inappropriate ioctl for device error, not sure the exact reason but follow this link works.

Add to ~/.gnupg/gpg.conf:

use-agent
pinentry-mode loopback

Add to ~/.gnupg/gpg-agent.conf

allow-loopback-pinentry

Then

...
[INFO] --- maven-gpg-plugin:1.5:sign (sign-artifacts) @ gitar ---
[INFO]
[INFO] --- maven-install-plugin:3.0.0-M1:install (default-install) @ gitar ---
[INFO] Installing ~/Workspace/gitar/target/gitar-[version].jar to ~/.m2/repository/com/gitenter/gitar/[version]/gitar-[version].jar
...
[INFO]
[INFO] --- nexus-staging-maven-plugin:1.6.7:deploy (injected-nexus-deploy) @ gitar ---
[INFO] Performing local staging (local stagingDirectory="/Users/cynthia/Workspace/gitar/target/nexus-staging/staging")...
[INFO]  + Using server credentials "ossrh" from Maven settings.
[INFO]  * Connected to Nexus at https://oss.sonatype.org:443/, is version 2.14.11-01 and edition "Professional"
[INFO]  * Using staging profile ID "a0db7f06860d88" (matched by Nexus).
[INFO] Installing /Users/cynthia/Workspace/gitar/target/gitar-[version].jar to /Users/cynthia/Workspace/gitar/target/nexus-staging/staging/a0db7f06860d88/com/gitenter/gitar/[version]/gitar-[version].jar
...
[INFO] Installing /Users/cynthia/Workspace/gitar/target/gitar-[version]-sources.jar.asc to /Users/cynthia/Workspace/gitar/target/nexus-staging/staging/a0db7f06860d88/com/gitenter/gitar/[version]/gitar-[version]-sources.jar.asc
[INFO] Performing remote staging...
[INFO]
[INFO]  * Remote staging into staging profile ID "a0db7f06860d88"
[INFO]  * Created staging repository with ID "comgitenter-1003".
[INFO]  * Staging repository at https://oss.sonatype.org:443/service/local/staging/deployByRepositoryId/comgitenter-1003
[INFO]  * Uploading locally staged artifacts to profile com.gitenter
Uploading to ossrh: https://oss.sonatype.org:443/service/local/staging/deployByRepositoryId/comgitenter-1003/com/gitenter/gitar/[version]/gitar-[version]-sources.jar
Uploaded to ossrh: https://oss.sonatype.org:443/service/local/staging/deployByRepositoryId/comgitenter-1003/com/gitenter/gitar/[version]/gitar-[version]-sources.jar (37 kB at 5.0 kB/s)
...
[INFO]  * Upload of locally staged artifacts finished.
[INFO]  * Closing staging repository with ID "comgitenter-1003".

Waiting for operation to complete...
.......

[INFO] Remote staged 1 repositories, finished with success.
[INFO] Remote staging repositories are being released...

Waiting for operation to complete...
...........

[INFO] Remote staging repositories released.
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 02:25 min
[INFO] Finished at: 2019-03-11T06:57:58-04:00
[INFO] ------------------------------------------------------------------------

It seems after that no need to do anything special through this link. The repository is already in https://oss.sonatype.org/ and properly released.

Repository URL for release download access: https://repo1.maven.org/maven2/com/gitenter/gitar/

Repository group that contains snapshots and releases: https://repo1.maven.org/maven2/com/gitenter/gitar/

TODO: