virtuslab / shuttlecraft

Shuttlecraft

A small library for deploying your artifacts to the remote repository

Supported remote repositories:

• Maven2 (including Nexus and Artifactory)

Soon to be supported:

• Nexus release staging
• Publishing to a local directory (e. g. ~/.m2)

Usage

See Demo.scala

implicit val dir = Paths.get(System.getProperty("fury.sharedDir"))

val jar = Paths.get("target", "shuttlecraft-demo.jar")

val artifact = Artifact(
  groupId = "com.example",
  artifactId = "shuttlecraft",
  version = "0.0.1-SNAPSHOT",
  author = None,
  license = None,
  dependencies = Set(
    ("com.lihaoyi","ujson_2.12","0.7.1")
  ),
  jar = jar
)

val mvnApi = new Maven2HttpApi(
  repositoryUrl = "http://localhost:8081/nexus/content/repositories/snapshots/",
  username = "admin",
  password = "admin123"
)

val bar = new Maven2ResourceFactory(gpgPassphrase = None, signed = false)

val publisher = new Maven2Publisher(mvnApi, resourceGen)

publisher.publish(artifact).recover{ case NonFatal(e) => log.error("Failed to publish the artifact", e) }

shuttlecraft's Issues

Shuttlecraft should look for repositories in the Maven settings

The file ~/.m2/settings.xml may contain definitions of remote repositories, their names, credentials and mirrors. It would be convenient if Shuttlecraft could re-use these settings.

Adding documentation to the artifact

The user should be able to generate documentation (scaladoc or javadoc)and publish it as a JAR along with the rest of the artifact.

Adding sources to the artifact

The user should be able to publish a sources JAR along with the rest of the artifact.

Provide a selection of common open-source licenses

The user should be able to attach one of the widely used open source licenses just by specifying its name.

Licenses can be taken from https://choosealicense.com/licenses.

Adding a license to the artifact

The user should be able to add a custom license file, which would be published along with the rest of the files that comprise the artifact.

Reporting progress

Shuttlecraft should report the progress of tasks more or less in real time, e. g. by drawing progress bars in the terminal.