Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
Skeleton sbt project with configuration to push to Sonatype.
  • Loading branch information
jferris committed Jan 24, 2019
0 parents commit 70e4695
Show file tree
Hide file tree
Showing 8 changed files with 163 additions and 0 deletions.
48 changes: 48 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,48 @@
# Contributing to Fable

We love pull requests from everyone. By participating in this project, you
agree to abide by the thoughtbot [code of conduct].

[code of conduct]: https://thoughtbot.com/open-source-code-of-conduct

Here are some ways *you* can contribute:

* by using alpha, beta, and prerelease versions
* by reporting bugs
* by suggesting new features
* by writing or editing documentation
* by writing specifications
* by writing code ( **no patch is too small** : fix typos, add comments, clean up inconsistent whitespace )
* by refactoring code
* by closing [issues][]
* by reviewing patches

[issues]: https://github.com/thoughtbot/fable/issues

## Submitting an Issue
We use the [GitHub issue tracker][issues] to track bugs and features. Before
submitting a bug report or feature request, check to make sure it hasn't
already been submitted. When submitting a bug report, please include a [Gist][]
that includes a stack trace and any details that may be necessary to reproduce
the bug, including your Fable version, Scala version, and operating system.
Ideally, a bug report should include a pull request with failing specs.

[gist]: https://gist.github.com/

## Submitting a Pull Request
1. [Fork][fork] the [official repository][repo].
2. [Create a topic branch.][branch]
3. Implement your feature or bug fix.
4. Add, commit, and push your changes.
5. [Submit a pull request.][pr]

## Notes
* Please add tests if you changed code. Contributions without tests won't be accepted.
* Please don't update the version.

[repo]: https://github.com/thoughtbot/fable/tree/master
[fork]: https://help.github.com/articles/fork-a-repo/
[branch]: https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/
[pr]: https://help.github.com/articles/using-pull-requests/

Inspired by https://github.com/middleman/middleman-heroku/blob/master/CONTRIBUTING.md
19 changes: 19 additions & 0 deletions LICENSE
@@ -0,0 +1,19 @@
Copyright (c) 2019 thoughtbot, inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
24 changes: 24 additions & 0 deletions README.md
@@ -0,0 +1,24 @@
# Fable

Functional API for Kafka using Cats, Cats Effect, and fs2.

## Installation

In `build.sbt`:

libraryDependencies += "com.thoughtbot" % "fable" %% "0.1.0"

## Synopsis

See the [Scaladoc] for more details.

## Contributing

Please see [CONTRIBUTING.md](/CONTRIBUTING.md).

## License

Fable is Copyright © 2019 thoughtbot. It is free software, and may be
redistributed under the terms specified in the [LICENSE](/LICENSE) file.

[Scaladoc]: https://scaladoc.thoughtbot.com/fable/fable/index.html
66 changes: 66 additions & 0 deletions build.sbt
@@ -0,0 +1,66 @@
import ReleaseTransformations._

lazy val fable = (project in file("."))
.settings(
inThisBuild(List(scalaVersion := "2.12.3")),
scalacOptions ++= Seq(
"-deprecation",
"-feature",
"-unchecked",
"-Xfatal-warnings",
"-Ypartial-unification",
"-Ywarn-unused-import"
),

autoAPIMappings := true,
developers := List(
Developer(
id="jferris",
name="Joe Ferris",
email="jferris@thoughtbot.com",
url=url("https://github.com/jferris")
)
),
licenses := Seq("MIT" -> url("http://opensource.org/licenses/MIT")),
homepage := Some(url("https://github.com/thoughtbot/fable")),
name := "fable",
organization := "com.thoughtbot",
publishMavenStyle := true,
publishTo := Some(
if (isSnapshot.value)
Opts.resolver.sonatypeSnapshots
else
Opts.resolver.sonatypeStaging
),
releasePublishArtifactsAction := PgpKeys.publishSigned.value,
scmInfo := Some(
ScmInfo(
url("https://github.com/thoughtbot/fable"),
"scm:git:git@github.com:thoughtbot/fable.git"
)
),
useGpg := true,

releaseProcess := Seq[ReleaseStep](
checkSnapshotDependencies,
inquireVersions,
runClean,
runTest,
setReleaseVersion,
commitReleaseVersion,
tagRelease,
publishArtifacts,
releaseStepCommand("sonatypeRelease"),
setNextVersion,
commitNextVersion,
pushChanges
),

libraryDependencies += scalaTest % Test
)
.settings(
libraryDependencies ++= Seq(
"com.chuusai" %% "shapeless" % "2.3.2",
"org.typelevel" %% "cats-core" % "1.0.0-RC1"
)
)
1 change: 1 addition & 0 deletions project/build.properties
@@ -0,0 +1 @@
sbt.version=1.2.8
3 changes: 3 additions & 0 deletions project/plugins.sbt
@@ -0,0 +1,3 @@
addSbtPlugin("com.github.gseitz" % "sbt-release" % "1.0.11")
addSbtPlugin("com.jsuereth" % "sbt-pgp" % "1.1.2")
addSbtPlugin("org.xerial.sbt" % "sbt-sonatype" % "2.4")
1 change: 1 addition & 0 deletions sonatype.sbt
@@ -0,0 +1 @@
sonatypeProfileName := "com.thoughtbot"
1 change: 1 addition & 0 deletions version.sbt
@@ -0,0 +1 @@
version in ThisBuild := "0.1.0-SNAPSHOT"

0 comments on commit 70e4695

Please sign in to comment.