From 5e01c83ae91cc3c6912ce1b1a486de5c86623ca4 Mon Sep 17 00:00:00 2001 From: "Ross A. Baker" Date: Mon, 8 Oct 2018 20:19:39 -0400 Subject: [PATCH 1/2] Move to io.getnelson organization --- README.md | 8 ++++---- docs/build.sbt | 2 +- docs/src/main/tut/usage.md | 2 +- project/CentralRequirementsPlugin.scala | 11 ++++++----- 4 files changed, 12 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 95f41f7..c65de6f 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,9 @@ Knobs ![image](docs/src/site/img/logo.png) [![Join the chat at https://gitter.im/oncue/knobs](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/oncue/knobs) -[![Build Status](https://travis-ci.org/Verizon/knobs.svg?branch=master)](https://travis-ci.org/Verizon/knobs) -[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.verizon.knobs/core_2.11/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.verizon.knobs/core_2.11) -[![codecov](https://codecov.io/gh/Verizon/knobs/branch/master/graph/badge.svg)](https://codecov.io/gh/Verizon/knobs) +[![Build Status](https://travis-ci.org/getnelson/knobs.svg?branch=master)](https://travis-ci.org/getnelson/knobs) +[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.getnelson.knobs/core_2.11/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.getnelson.knobs/core_2.11) +[![codecov](https://codecov.io/gh/getnelson/knobs/branch/master/graph/badge.svg)](https://codecov.io/gh/getnelson/knobs) -Please [view the documentation](http://oncue.github.io/knobs/) for more information, and go to [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22io.verizon.knobs%22) for the latest releases. +Please [view the documentation](http://getnelson.github.io/knobs/) for more information, and go to [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22io.getnelson.knobs%22) for the latest releases. diff --git a/docs/build.sbt b/docs/build.sbt index 7af94a3..7504c73 100644 --- a/docs/build.sbt +++ b/docs/build.sbt @@ -16,5 +16,5 @@ ghpagesNoJekyll := false includeFilter in makeSite := "*.yml" | "*.md" | "*.html" | "*.css" | "*.png" | "*.jpg" | "*.gif" | "*.js" | "*.swf" -git.remoteRepo := "git@github.com:Verizon/knobs.git" +git.remoteRepo := "git@github.com:getnelson/knobs.git" diff --git a/docs/src/main/tut/usage.md b/docs/src/main/tut/usage.md index ac8281f..1a6847f 100644 --- a/docs/src/main/tut/usage.md +++ b/docs/src/main/tut/usage.md @@ -11,7 +11,7 @@ section: "usage" First you need to add the dependency for Knobs to your `build.scala` or your `build.sbt` file: ```` -libraryDependencies += "io.verizon.knobs" %% "core" % "x.x.+" +libraryDependencies += "io.getnelson.knobs" %% "core" % "x.x.+" ```` Where `x.x` is the desired Knobs version. Knobs follows traditional [semantic versioning](semver). Check for the latest release [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22io.verizon.knobs%22). diff --git a/project/CentralRequirementsPlugin.scala b/project/CentralRequirementsPlugin.scala index 58e338f..9b4592c 100644 --- a/project/CentralRequirementsPlugin.scala +++ b/project/CentralRequirementsPlugin.scala @@ -14,8 +14,9 @@ //: limitations under the License. //: //: ---------------------------------------------------------------------------- -package verizon.build +package io.getnelson.knobs.build +import verizon.build.RigPlugin import sbt._, Keys._ import xerial.sbt.Sonatype.autoImport.sonatypeProfileName @@ -26,7 +27,7 @@ object CentralRequirementsPlugin extends AutoPlugin { override def requires = RigPlugin override lazy val projectSettings = Seq( - sonatypeProfileName := "io.verizon", + sonatypeProfileName := "io.getnelson", pomExtra in Global := { @@ -47,8 +48,8 @@ object CentralRequirementsPlugin extends AutoPlugin { }, licenses := Seq("Apache-2.0" -> url("https://www.apache.org/licenses/LICENSE-2.0.html")), - homepage := Some(url("http://verizon.github.io/knobs/")), - scmInfo := Some(ScmInfo(url("https://github.com/verizon/knobs"), - "git@github.com:verizon/knobs.git")) + homepage := Some(url("http://getnelson.github.io/knobs/")), + scmInfo := Some(ScmInfo(url("https://github.com/getnelson/knobs"), + "git@github.com:getnelson/knobs.git")) ) } From 564513cad943d77dea0d2bf61f351ebb4b467df2 Mon Sep 17 00:00:00 2001 From: "Ross A. Baker" Date: Tue, 9 Oct 2018 12:36:47 -0400 Subject: [PATCH 2/2] Fix tut rot --- docs/build.sbt | 3 +++ docs/src/main/tut/usage.md | 7 +++++-- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/build.sbt b/docs/build.sbt index 7504c73..dde5244 100644 --- a/docs/build.sbt +++ b/docs/build.sbt @@ -18,3 +18,6 @@ includeFilter in makeSite := "*.yml" | "*.md" | "*.html" | "*.css" | "*.png" | " git.remoteRepo := "git@github.com:getnelson/knobs.git" +scalacOptions ~= { + _.filterNot(Set("-Ywarn-unused:params", "-Ywarn-unused:imports")) +} diff --git a/docs/src/main/tut/usage.md b/docs/src/main/tut/usage.md index 1a6847f..1463cbe 100644 --- a/docs/src/main/tut/usage.md +++ b/docs/src/main/tut/usage.md @@ -46,9 +46,12 @@ To require the file "foo.cfg" from the classpath: ```tut import knobs.{Required,ClassPathResource,Config} -import cats.effect.IO +import cats.effect.{ContextShift, IO} import scala.concurrent.ExecutionContext.Implicits.global +// Provided automatically if you're in IOApp +implicit val cs: ContextShift[IO] = IO.contextShift(global) + val cfg: IO[Config] = knobs.loadImmutable[IO]( Required(ClassPathResource("foo.cfg")) :: Nil) ``` @@ -268,7 +271,7 @@ val c1: IO[Config] = val cfg = for { a <- c1 - b <- aws.config + b <- aws.config[IO] } yield a ++ b ```