Skip to content

Commit

Permalink
Merge pull request xebia-functional#335 from 47degrees/prepare-for-.g…
Browse files Browse the repository at this point in the history
…ithub-release
  • Loading branch information
alejandrohdezma authored May 26, 2020
2 parents 593d351 + e485a5c commit 3bea4d5
Show file tree
Hide file tree
Showing 75 changed files with 112 additions and 340 deletions.
2 changes: 2 additions & 0 deletions .github/actions.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
pre:
docs: 'gem install jekyll -v 4'
201 changes: 0 additions & 201 deletions LICENSE

This file was deleted.

20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,28 @@
# Fetch

[comment]: # (Start Badges)

[![Join the chat at https://gitter.im/47deg/fetch](https://badges.gitter.im/47deg/fetch.svg)](https://gitter.im/47deg/fetch?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![codecov.io](http://codecov.io/github/47deg/fetch/coverage.svg?branch=master)](http://codecov.io/github/47deg/fetch?branch=master) [![Maven Central](https://img.shields.io/badge/maven%20central-1.2.1-green.svg)](https://oss.sonatype.org/#nexus-search;gav~com.47deg~fetch*) [![License](https://img.shields.io/badge/license-Apache%202-blue.svg)](https://raw.githubusercontent.com/47deg/fetch/master/LICENSE) [![Latest version](https://img.shields.io/badge/fetch-1.2.1-green.svg)](https://index.scala-lang.org/47deg/fetch) [![Scala.js](http://scala-js.org/assets/badges/scalajs-0.6.15.svg)](http://scala-js.org) [![GitHub Issues](https://img.shields.io/github/issues/47deg/fetch.svg)](https://github.com/47deg/fetch/issues)

[comment]: # (End Badges)

A library for Simple & Efficient data access in Scala and Scala.js

- [Documentation](https://47degrees.github.io/fetch/docs)

---

- [Installation](#installation)
- [Remote data](#remote-data)
- [Define your data sources](#define-your-data-sources)
- [Creating a runtime](#creating-a-runtime)
- [Creating and running a fetch](#creating-and-running-a-fetch)
- [Batching](#batching)
- [Parallelism](#parallelism)
- [Caching](#caching)

## Installation

Add the following dependency to your project's build file.

For Scala 2.11.x and 2.12.x:

[comment]: # (Start Replace)

```scala
"com.47deg" %% "fetch" % "1.3.0"
```
Expand All @@ -28,9 +33,6 @@ Or, if using Scala.js (0.6.x):
"com.47deg" %%% "fetch" % "1.3.0"
```

[comment]: # (End Replace)


## Remote data

Fetch is a library for making access to data both simple and efficient. Fetch is especially useful when querying data that
Expand Down
55 changes: 17 additions & 38 deletions build.sbt
Original file line number Diff line number Diff line change
@@ -1,60 +1,39 @@
import sbtcrossproject.CrossPlugin.autoImport.{crossProject, CrossType}
ThisBuild / scalaVersion := "2.13.2"
ThisBuild / crossScalaVersions := Seq("2.12.11", "2.13.2")
ThisBuild / organization := "com.47deg"

lazy val checkScalafmt = "+scalafmtCheckAll; +scalafmtSbtCheck;"
lazy val checkDocs = "+docs/mdoc;"
lazy val checkJSTests = "+fetchJS/test; +debugJS/test;"
lazy val checkJVMTests =
"+coverage; +fetchJVM/test; +debugJVM/test; +examples/test; +coverageReport; +coverageAggregate;"
addCommandAlias("ci-test", "scalafmtCheckAll; scalafmtSbtCheck; mdoc; testCovered")
addCommandAlias("ci-docs", "github; mdoc; headerCreateAll; publishMicrosite")
addCommandAlias("ci-publish", "github; ci-release")

addCommandAlias(
"ci-test",
s"$checkScalafmt $checkDocs $checkJSTests $checkJVMTests"
)
addCommandAlias("ci-docs", "project-docs/mdoc; headerCreateAll")
addCommandAlias("ci-microsite", "docs/publishMicrosite")

lazy val root = project
.in(file("."))
.settings(name := "fetch")
.settings(moduleName := "root")
.aggregate(fetchJS, fetchJVM, debugJVM, debugJS)
skip in publish := true

lazy val fetch = crossProject(JSPlatform, JVMPlatform)
.in(file("."))
.settings(name := "fetch")
.crossType(CrossType.Pure)
.settings(commonCrossDependencies)

lazy val fetchJVM = fetch.jvm
lazy val fetchJS = fetch.js.disablePlugins(ScoverageSbtPlugin)

lazy val debug = crossProject(JSPlatform, JVMPlatform)
.in(file("debug"))
.settings(name := "fetch-debug")
lazy val `fetch-debug` = crossProject(JSPlatform, JVMPlatform)
.crossType(CrossType.Pure)
.dependsOn(fetch)
.settings(commonCrossDependencies)
lazy val debugJVM = `fetch-debug`.jvm
lazy val debugJS = `fetch-debug`.js.disablePlugins(ScoverageSbtPlugin)

lazy val debugJVM = debug.jvm
lazy val debugJS = debug.js.disablePlugins(ScoverageSbtPlugin)

lazy val examples = (project in file("examples"))
.settings(name := "fetch-examples")
lazy val `fetch-examples` = project
.dependsOn(fetchJVM, debugJVM)
.settings(skip in publish := true)
.settings(examplesSettings: _*)

lazy val docs = (project in file("docs"))
lazy val microsite = project
.dependsOn(fetchJVM, debugJVM)
.settings(name := "fetch-docs")
.settings(docsSettings: _*)
.settings(skip in publish := true)
.enablePlugins(MicrositesPlugin)
.enablePlugins(MdocPlugin)
.enablePlugins(MicrositesPlugin, MdocPlugin)

lazy val `project-docs` = (project in file(".docs"))
.aggregate(fetchJVM)
lazy val documentation = project
.dependsOn(fetchJVM)
.settings(moduleName := "fetch-project-docs")
.settings(mdocIn := file(".docs"))
.settings(mdocOut := file("."))
.settings(skip in publish := true)
.settings(mdocOut := file("."))
.enablePlugins(MdocPlugin)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
11 changes: 3 additions & 8 deletions .docs/README.md → docs/README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,20 @@
# Fetch

[comment]: # (Start Badges)

[![Join the chat at https://gitter.im/47deg/fetch](https://badges.gitter.im/47deg/fetch.svg)](https://gitter.im/47deg/fetch?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![codecov.io](http://codecov.io/github/47deg/fetch/coverage.svg?branch=master)](http://codecov.io/github/47deg/fetch?branch=master) [![Maven Central](https://img.shields.io/badge/maven%20central-1.2.1-green.svg)](https://oss.sonatype.org/#nexus-search;gav~com.47deg~fetch*) [![License](https://img.shields.io/badge/license-Apache%202-blue.svg)](https://raw.githubusercontent.com/47deg/fetch/master/LICENSE) [![Latest version](https://img.shields.io/badge/fetch-1.2.1-green.svg)](https://index.scala-lang.org/47deg/fetch) [![Scala.js](http://scala-js.org/assets/badges/scalajs-0.6.15.svg)](http://scala-js.org) [![GitHub Issues](https://img.shields.io/github/issues/47deg/fetch.svg)](https://github.com/47deg/fetch/issues)

[comment]: # (End Badges)

A library for Simple & Efficient data access in Scala and Scala.js

- [Documentation](https://47degrees.github.io/fetch/docs)

```scala mdoc:toc
```

## Installation

Add the following dependency to your project's build file.

For Scala 2.11.x and 2.12.x:

[comment]: # (Start Replace)

```scala
"com.47deg" %% "fetch" % "@VERSION@"
```
Expand All @@ -28,8 +25,6 @@ Or, if using Scala.js (0.6.x):
"com.47deg" %%% "fetch" % "@VERSION@"
```

[comment]: # (End Replace)

```scala mdoc:invisible
val out = Console.out

Expand Down
File renamed without changes.
File renamed without changes.
Loading

0 comments on commit 3bea4d5

Please sign in to comment.