Skip to content

Commit 1ff928e

Browse files
Prepare repository for next .github release and SBT build improvements (#501)
1 parent fb47146 commit 1ff928e

36 files changed

Lines changed: 50 additions & 105 deletions

.github/actions.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
pre:
2+
docs: 'gem install jekyll -v 4'

README.md

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11

2-
[comment]: # (Start Badges)
3-
42
[![Join the chat at https://gitter.im/47degrees/github4s](https://badges.gitter.im/47degrees/github4s.svg)](https://gitter.im/47degrees/github4s?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![codecov.io](http://codecov.io/gh/47degrees/github4s/branch/master/graph/badge.svg)](http://codecov.io/gh/47degrees/github4s) [![Maven Central](https://img.shields.io/badge/maven%20central-0.24.0-green.svg)](https://oss.sonatype.org/#nexus-search;gav~com.47deg~github4s*) [![License](https://img.shields.io/badge/license-Apache%202-blue.svg)](https://raw.githubusercontent.com/47degrees/github4s/master/LICENSE) [![Latest version](https://img.shields.io/badge/github4s-0.24.0-green.svg)](https://index.scala-lang.org/47degrees/github4s) [![GitHub Issues](https://img.shields.io/github/issues/47degrees/github4s.svg)](https://github.com/47degrees/github4s/issues)
53

6-
[comment]: # (End Badges)
7-
84
Github4s
95
=============
106

@@ -14,14 +10,10 @@ Github4s
1410

1511
To get started with SBT, simply add the following to your build.sbt file.
1612

17-
[comment]: # (Start Replace)
18-
1913
```scala
2014
libraryDependencies += "com.47deg" %% "github4s" % "0.24.0"
2115
```
2216

23-
[comment]: # (End Replace)
24-
2517
## Github4s in the wild
2618

2719
If you wish to add your library here please consider a PR to include it in the list below.
@@ -32,11 +24,8 @@ If you wish to add your library here please consider a PR to include it in the l
3224
| | [**dashing**](https://github.com/benfradet/dashing) | Dashing is a collection of dashboards to monitor the health of an open source organization.
3325
| | [**cla-bot**](https://github.com/snowplow-incubator/cla-bot) | Bot making sure external contributors sign a CLA.
3426

35-
[comment]: # (Start Copyright)
3627
# Copyright
3728

3829
Github4s is designed and developed by 47 Degrees
3930

4031
Copyright (C) 2016-2020 47 Degrees. <http://47deg.com>
41-
42-
[comment]: # (End Copyright)

build.sbt

Lines changed: 14 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,28 @@
1-
addCommandAlias("ci-test", "+scalafmtCheckAll; +scalafmtSbtCheck; +docs/mdoc; +test")
2-
addCommandAlias("ci-docs", "project-docs/mdoc; docs/mdoc; headerCreateAll")
3-
addCommandAlias("ci-microsite", "docs/publishMicrosite")
1+
ThisBuild / organization := "com.47deg"
2+
ThisBuild / scalaVersion := "2.13.2"
3+
ThisBuild / crossScalaVersions := Seq("2.12.11", "2.13.2")
4+
5+
addCommandAlias("ci-test", "scalafmtCheckAll; scalafmtSbtCheck; mdoc; testCovered")
6+
addCommandAlias("ci-docs", "github; mdoc; headerCreateAll; publishMicrosite")
7+
addCommandAlias("ci-publish", "github; ci-release")
48

59
skip in publish := true
610

7-
lazy val github4s = project
8-
.enablePlugins(BuildInfoPlugin)
9-
.settings(
10-
buildInfoKeys := Seq[BuildInfoKey](
11-
name,
12-
version,
13-
"token" -> sys.env.getOrElse("GITHUB_TOKEN", "")
14-
),
15-
buildInfoPackage := "github4s"
16-
)
17-
.settings(coreDeps: _*)
11+
lazy val github4s = project.settings(coreDeps: _*)
1812

1913
//////////
2014
// DOCS //
2115
//////////
2216

23-
lazy val docs: Project = project
24-
.aggregate(github4s)
17+
lazy val microsite: Project = project
2518
.dependsOn(github4s)
26-
.settings(micrositeSettings: _*)
27-
.settings(skip in publish := true)
2819
.enablePlugins(MicrositesPlugin)
2920
.enablePlugins(ScalaUnidocPlugin)
30-
.settings(
31-
unidocProjectFilter in (ScalaUnidoc, unidoc) := inProjects(github4s, docs)
32-
)
21+
.settings(micrositeSettings: _*)
22+
.settings(skip in publish := true)
23+
.settings(unidocProjectFilter in (ScalaUnidoc, unidoc) := inProjects(github4s, microsite))
3324

34-
lazy val `project-docs` = (project in file(".docs"))
35-
.aggregate(github4s)
36-
.dependsOn(github4s)
37-
.settings(moduleName := "github4s-project-docs")
38-
.settings(mdocIn := file(".docs"))
25+
lazy val documentation = project
26+
.enablePlugins(MdocPlugin)
3927
.settings(mdocOut := file("."))
4028
.settings(skip in publish := true)
41-
.enablePlugins(MdocPlugin)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11

2-
[comment]: # (Start Badges)
3-
42
[![Join the chat at https://gitter.im/47degrees/github4s](https://badges.gitter.im/47degrees/github4s.svg)](https://gitter.im/47degrees/github4s?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![codecov.io](http://codecov.io/gh/47degrees/github4s/branch/master/graph/badge.svg)](http://codecov.io/gh/47degrees/github4s) [![Maven Central](https://img.shields.io/badge/maven%20central-@VERSION@-green.svg)](https://oss.sonatype.org/#nexus-search;gav~com.47deg~github4s*) [![License](https://img.shields.io/badge/license-Apache%202-blue.svg)](https://raw.githubusercontent.com/47degrees/github4s/master/LICENSE) [![Latest version](https://img.shields.io/badge/github4s-@VERSION@-green.svg)](https://index.scala-lang.org/47degrees/github4s) [![GitHub Issues](https://img.shields.io/github/issues/47degrees/github4s.svg)](https://github.com/47degrees/github4s/issues)
53

6-
[comment]: # (End Badges)
7-
84
Github4s
95
=============
106

@@ -14,14 +10,10 @@ Github4s
1410

1511
To get started with SBT, simply add the following to your build.sbt file.
1612

17-
[comment]: # (Start Replace)
18-
1913
```scala
2014
libraryDependencies += "com.47deg" %% "github4s" % "@VERSION@"
2115
```
2216

23-
[comment]: # (End Replace)
24-
2517
## Github4s in the wild
2618

2719
If you wish to add your library here please consider a PR to include it in the list below.
@@ -32,11 +24,8 @@ If you wish to add your library here please consider a PR to include it in the l
3224
| | [**dashing**](https://github.com/benfradet/dashing) | Dashing is a collection of dashboards to monitor the health of an open source organization.
3325
| | [**cla-bot**](https://github.com/snowplow-incubator/cla-bot) | Bot making sure external contributors sign a CLA.
3426

35-
[comment]: # (Start Copyright)
3627
# Copyright
3728

3829
Github4s is designed and developed by 47 Degrees
3930

4031
Copyright (C) 2016-2020 47 Degrees. <http://47deg.com>
41-
42-
[comment]: # (End Copyright)
File renamed without changes.

0 commit comments

Comments
 (0)