Skip to content

Latest commit

 

History

History
100 lines (68 loc) · 2.56 KB

README.adoc

File metadata and controls

100 lines (68 loc) · 2.56 KB

SBuild HTTPS Plugin

This SBuild Plugin provides an HTTPS SchemeHandler for SBuild.

Download

The SBuild HTTPS Plugin can be downloaded from Maven Central.

To include it in your SBuild build file use the @classpath annotation:

@classpath("mvn:org.sbuild:org.sbuild.plugins.https:0.1.0")

Building from Source

If you want to build this plugin from source, you need at least SBuild 0.7.1.

git clone https://github.com/SBuild-org/sbuild-https-plugin.git
cd sbuild-sbuild-plugin/org.sbuild.plugins.https
sbuild jar

You will find the built jar in the directory org.sbuild.plugins.https/target.

Configuration

All configurable properties are documented via ScalaDoc. See file Https.scala.

In it’s default configuration, this plugin will register a https scheme, which will store all downloaded resources under .sbuild/https.

Named plugin instances will register a scheme identical to the plugin instance name.

Examples

Just using the default configuration:

import de.tototec.sbuild._

@version("0.7.9010.0.8.0-M1")
@classpath("mvn:org.sbuild:org.sbuild.plugins.https:0.1.0")
class SBuild(implicit _project: Project) {

  Plugin[org.sbuild.plugins.https.Https]

  Target("phony:download") dependsOn "https://raw.github.com/SBuild-org/sbuild-jbake/master/README.adoc"

}

Registering an unsafeHttps scheme and disable trust management, to allow connections to sites with self signed certificates.

import de.tototec.sbuild._

@version("0.7.9010.0.8.0-M1")
@classpath("mvn:org.sbuild:org.sbuild.plugins.https:0.1.0")
class SBuild(implicit _project: Project) {

  Plugin[org.sbuild.plugins.https.Https]("unsafeHttps") configure { _.copy(
    disableTrustManager = true
  )}

  // sbuild.tototec.de uses a self signed certificate.
  Target("phony:download") dependsOn "unsafeHttps://sbuild.tototec.de/sbuild/attachments/download/88/de.tototec.sbuild-0.7.1.jar"

}

Changelog

Compatibility Matrix

Https Plugin Version SBuild Version

0.1.0

>= 0.8.0-M1 (0.7.9010)

sbuild-https-plugin 0.1.0

  • Initial Release

  • Requires SBuild 0.8.0-M1 (0.7.9010)