README.md

Publish with headers SBT plugin

This is an SBT plugin to add http headers when publishing Maven artifacts.

It's mostly based on the: https://github.com/k8ty-app/sbt-publish and sbt/sbt#4382 (comment)

Installation

Clone this repo and run sbt publishLocal

Configuration

Enable the plugin in the <project-root>/project/plugins.sbt or $HOME/.sbt/1.0/plugins/build.sbt for a global configuration:

addSbtPlugin("org.jboss.pnc.sbt.plugins" % "publish-with-headers" % "0.0.1")

Configure the plugin in the <project-root>/build.sbt or $HOME/.sbt/1.0/global.sbt for a global configuration:

PublishWithHeadersPlugin.headers := "header-key:header-value,header-key-2:header-value-2"
publishTo := Some("MavenRepo" at s"https://maven-repo-host/path"),
//in case you are still using an endpoit without TLS
publishTo := Some(("MavenRepo" at s"http://maven-repo-host/path").withAllowInsecureProtocol(true)),

Execution

To publish to a Maven repository with http headers run:

sbt whPublish

Just in case

you need http headers for fetching the dependencies from the Maven repository.

Coursier is used as a default dependency resolver since SBT 1.3.x and it supports custom http headers.

Configure headers in the <project-root>/build.sbt or $HOME/.sbt/1.0/global.sbt for a global configuration:

import lmcoursier.definitions.Authentication

csrConfiguration := csrConfiguration.value
  .addRepositoryAuthentication("my-repo-id", Authentication("", "").withHeaders(Seq(("header-key","header-value"))))
resolvers += ("my-repo-id" at "https://maven-repo-host/path")