Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prepare repository for next .github release, SBT build improvements and fix microsite creation #490

Merged
merged 19 commits into from
Jul 13, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
b7a7f9a
Separete plugin build dependencies to its own file
alejandrohdezma Jul 11, 2020
0636425
These resolvers aren't needed
alejandrohdezma Jul 11, 2020
737f475
Update plugins to latest version & remove those that are not used
alejandrohdezma Jul 11, 2020
b327835
Update SBT version
alejandrohdezma Jul 11, 2020
dc06cf0
Move docs to `docs` & microsite docs to `microsite`
alejandrohdezma Jul 11, 2020
09ca87e
Move `organization` and scala version settings as build settings
alejandrohdezma Jul 11, 2020
83ea52c
Inline versions since they are going to be managed by Scala Steward
alejandrohdezma Jul 11, 2020
e0574d2
These settings are not needed
alejandrohdezma Jul 11, 2020
fc9fdd0
sbt-buildinfo plugin is no longer used
alejandrohdezma Jul 11, 2020
402f77e
Resources should also be included as part of the SBT build
alejandrohdezma Jul 12, 2020
6135206
For the plugin's own site to make, we need to copy resource folders
alejandrohdezma Jul 12, 2020
c561888
Use Mdoc instead of Tut
alejandrohdezma Jul 12, 2020
93e1967
Add remove-test-from-pom plugin to remove test dependencies from POM
alejandrohdezma Jul 12, 2020
7263259
Join `publishMicrosite` into `ci-docs`
alejandrohdezma Jul 12, 2020
44c6e89
Add `ci-publish` alias that will be used to release new artifacts
alejandrohdezma Jul 12, 2020
0995751
Enable downloading info from Github before `ci-docs`/`ci-publish`
alejandrohdezma Jul 12, 2020
879af70
Add `actions.yml` file that will be used by `.github` in next release
alejandrohdezma Jul 12, 2020
b64cddc
Remove `sbt-org-policies` old markers
alejandrohdezma Jul 12, 2020
3fa32ca
Create README template and execute `sbt documentation/mdoc`
alejandrohdezma Jul 12, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/actions.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
pre:
ci: 'gem install jekyll -v 4'
docs: 'gem install jekyll -v 4'
44 changes: 43 additions & 1 deletion AUTHORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,25 @@

The maintainers of the project are:

- [![47erbot](https://avatars1.githubusercontent.com/u/24799081?v=4&s=20) **47erbot**](https://github.com/47erbot)
- [![AdrianRaFo](https://avatars0.githubusercontent.com/u/15971742?v=4&s=20) **Adrian Ramirez Fornell (AdrianRaFo)**](https://github.com/AdrianRaFo)
- [![alejandrohdezma](https://avatars0.githubusercontent.com/u/9027541?v=4&s=20) **Alejandro Hernández (alejandrohdezma)**](https://github.com/alejandrohdezma)
- [![anamariamv](https://avatars0.githubusercontent.com/u/2183589?v=4&s=20) **Ana Mª Marquez (anamariamv)**](https://github.com/anamariamv)
- [![AntonioMateoGomez](https://avatars0.githubusercontent.com/u/25897490?v=4&s=20) **Antonio Mateo (AntonioMateoGomez)**](https://github.com/AntonioMateoGomez)
- [![BenFradet](https://avatars2.githubusercontent.com/u/1737211?v=4&s=20) **Ben Fradet (BenFradet)**](https://github.com/BenFradet)
- [![cb372](https://avatars1.githubusercontent.com/u/106760?v=4&s=20) **Chris Birchall (cb372)**](https://github.com/cb372)
- [![diesalbla](https://avatars1.githubusercontent.com/u/1764610?v=4&s=20) **Diego E. Alonso Blas (diesalbla)**](https://github.com/diesalbla)
- [![dominv](https://avatars1.githubusercontent.com/u/3943031?v=4&s=20) **Domingo Valera (dominv)**](https://github.com/dominv)
- [![fedefernandez](https://avatars0.githubusercontent.com/u/720923?v=4&s=20) **Fede Fernández (fedefernandez)**](https://github.com/fedefernandez)
- [![franciscodr](https://avatars1.githubusercontent.com/u/1200151?v=4&s=20) **Francisco Diaz (franciscodr)**](https://github.com/franciscodr)
- [![israelperezglez](https://avatars1.githubusercontent.com/u/646886?v=4&s=20) **Israel Pérez (israelperezglez)**](https://github.com/israelperezglez)
- [![jkmcclellan](https://avatars3.githubusercontent.com/u/52432856?v=4&s=20) **Jason McClellan (jkmcclellan)**](https://github.com/jkmcclellan)
- [![jdesiloniz](https://avatars2.githubusercontent.com/u/2835739?v=4&s=20) **Javier de Silóniz Sandino (jdesiloniz)**](https://github.com/jdesiloniz)
- [![juanpedromoreno](https://avatars2.githubusercontent.com/u/4879373?v=4&s=20) **Juan Pedro Moreno (juanpedromoreno)**](https://github.com/juanpedromoreno)
- [![calvellido](https://avatars0.githubusercontent.com/u/7753447?v=4&s=20) **Juan Valencia (calvellido)**](https://github.com/calvellido)
- [![MaureenElsberry](https://avatars0.githubusercontent.com/u/17556002?v=4&s=20) **Maureen Elsberry (MaureenElsberry)**](https://github.com/MaureenElsberry)
- [![noelmarkham](https://avatars1.githubusercontent.com/u/1492487?v=4&s=20) **Noel Markham (noelmarkham)**](https://github.com/noelmarkham)
- [![pepegar](https://avatars0.githubusercontent.com/u/694179?v=4&s=20) **Pepe García (pepegar)**](https://github.com/pepegar)
- [![rafaparadela](https://avatars3.githubusercontent.com/u/315070?v=4&s=20) **Rafa Paradela (rafaparadela)**](https://github.com/rafaparadela)

## Contributors
Expand Down Expand Up @@ -52,4 +61,37 @@ These are the people that have contributed to the _sbt-microsites_ project:
- [![britneywright](https://avatars2.githubusercontent.com/u/4439228?v=4&s=20) **britneywright**](https://github.com/britneywright)
- [![noelmarkham](https://avatars1.githubusercontent.com/u/1492487?v=4&s=20) **noelmarkham**](https://github.com/noelmarkham)
- [![franciscodr](https://avatars1.githubusercontent.com/u/1200151?v=4&s=20) **franciscodr**](https://github.com/franciscodr)
- [![julien-truffaut](https://avatars1.githubusercontent.com/u/1859417?v=4&s=20) **julien-truffaut**](https://github.com/julien-truffaut)
- [![julien-truffaut](https://avatars1.githubusercontent.com/u/1859417?v=4&s=20) **julien-truffaut**](https://github.com/julien-truffaut)
- [![ryan-williams](https://avatars1.githubusercontent.com/u/465045?v=4&s=20) **ryan-williams**](https://github.com/ryan-williams)
- [![travisbrown](https://avatars3.githubusercontent.com/u/316049?v=4&s=20) **travisbrown**](https://github.com/travisbrown)
- [![vlovgr](https://avatars1.githubusercontent.com/u/1163201?v=4&s=20) **vlovgr**](https://github.com/vlovgr)
- [![xuwei-k](https://avatars0.githubusercontent.com/u/389787?v=4&s=20) **xuwei-k**](https://github.com/xuwei-k)
- [![alejandrohdezma](https://avatars0.githubusercontent.com/u/9027541?v=4&s=20) **alejandrohdezma**](https://github.com/alejandrohdezma)
- [![anamariamv](https://avatars0.githubusercontent.com/u/2183589?v=4&s=20) **anamariamv**](https://github.com/anamariamv)
- [![Antoniojimenez47](https://avatars3.githubusercontent.com/u/24649817?v=4&s=20) **Antoniojimenez47**](https://github.com/Antoniojimenez47)
- [![ChristopherDavenport](https://avatars0.githubusercontent.com/u/10272700?v=4&s=20) **ChristopherDavenport**](https://github.com/ChristopherDavenport)
- [![erikerlandson](https://avatars0.githubusercontent.com/u/259898?v=4&s=20) **erikerlandson**](https://github.com/erikerlandson)
- [![eperinan](https://avatars3.githubusercontent.com/u/3660921?v=4&s=20) **eperinan**](https://github.com/eperinan)
- [![felixmulder](https://avatars1.githubusercontent.com/u/1530049?v=4&s=20) **felixmulder**](https://github.com/felixmulder)
- [![fthomas](https://avatars1.githubusercontent.com/u/141252?v=4&s=20) **fthomas**](https://github.com/fthomas)
- [![jatcwang](https://avatars0.githubusercontent.com/u/4957161?v=4&s=20) **jatcwang**](https://github.com/jatcwang)
- [![jpzk](https://avatars3.githubusercontent.com/u/31909?v=4&s=20) **jpzk**](https://github.com/jpzk)
- [![guersam](https://avatars3.githubusercontent.com/u/969120?v=4&s=20) **guersam**](https://github.com/guersam)
- [![jcazevedo](https://avatars2.githubusercontent.com/u/143188?v=4&s=20) **jcazevedo**](https://github.com/jcazevedo)
- [![jonas](https://avatars2.githubusercontent.com/u/8417?v=4&s=20) **jonas**](https://github.com/jonas)
- [![mcanlas](https://avatars0.githubusercontent.com/u/881934?v=4&s=20) **mcanlas**](https://github.com/mcanlas)
- [![thesamet](https://avatars0.githubusercontent.com/u/307373?v=4&s=20) **thesamet**](https://github.com/thesamet)
- [![Taig](https://avatars0.githubusercontent.com/u/567857?v=4&s=20) **Taig**](https://github.com/Taig)
- [![philwills](https://avatars2.githubusercontent.com/u/68329?v=4&s=20) **philwills**](https://github.com/philwills)
- [![pdalpra](https://avatars1.githubusercontent.com/u/1514127?v=4&s=20) **pdalpra**](https://github.com/pdalpra)
- [![metasim](https://avatars3.githubusercontent.com/u/131013?v=4&s=20) **metasim**](https://github.com/metasim)
- [![gitter-badger](https://avatars2.githubusercontent.com/u/8518239?v=4&s=20) **gitter-badger**](https://github.com/gitter-badger)
- [![NeQuissimus](https://avatars0.githubusercontent.com/u/628342?v=4&s=20) **NeQuissimus**](https://github.com/NeQuissimus)
- [![valydia](https://avatars1.githubusercontent.com/u/2129101?v=4&s=20) **valydia**](https://github.com/valydia)
- [![vaslabs](https://avatars2.githubusercontent.com/u/3875429?v=4&s=20) **vaslabs**](https://github.com/vaslabs)
- [![jvican](https://avatars0.githubusercontent.com/u/2462974?v=4&s=20) **jvican**](https://github.com/jvican)
- [![kczulko](https://avatars0.githubusercontent.com/u/19495571?v=4&s=20) **kczulko**](https://github.com/kczulko)
- [![kencyke](https://avatars2.githubusercontent.com/u/26133249?v=4&s=20) **kencyke**](https://github.com/kencyke)
- [![lldh](https://avatars0.githubusercontent.com/u/2140264?v=4&s=20) **lldh**](https://github.com/lldh)
- [![pepegar](https://avatars0.githubusercontent.com/u/694179?v=4&s=20) **pepegar**](https://github.com/pepegar)
- [![slice](https://avatars0.githubusercontent.com/u/4206232?v=4&s=20) **slice**](https://github.com/slice)
12 changes: 1 addition & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@

[comment]: # (Start Badges)

[![Maven Central](https://img.shields.io/badge/maven%20central-1.2.1-green.svg)](https://repo1.maven.org/maven2/com/47deg/sbt-microsites_2.12_1.0) [![License](https://img.shields.io/badge/license-Apache%202-blue.svg)](https://raw.githubusercontent.com/47degrees/sbt-microsites/master/LICENSE) [![Join the chat at https://gitter.im/47degrees/sbt-microsites](https://badges.gitter.im/47degrees/sbt-microsites.svg)](https://gitter.im/47degrees/sbt-microsites?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![GitHub Issues](https://img.shields.io/github/issues/47degrees/sbt-microsites.svg)](https://github.com/47degrees/sbt-microsites/issues)

[comment]: # (End Badges)

# sbt-microsites

**sbt-microsites** is an SBT plugin that facilitates the creation of fancy microsites for your projects, with minimal tweaks.
Expand All @@ -21,15 +17,12 @@ A microsite is an instance of Jekyll, ready to publish a static web page for you

To begin, add the following lines to the `project/plugins.sbt` file within your project or sbt module where you want to use the `sbt-microsites` plugin.

[comment]: # (Start Replace)

```
addSbtPlugin("com.47deg" % "sbt-microsites" % "1.2.1")
```

[comment]: # (End Replace)

Finally, to enable the plugin, add this to your `build.sbt` file:

```
enablePlugins(MicrositesPlugin)
```
Expand Down Expand Up @@ -71,11 +64,8 @@ Many Scala projects, libraries, and applications use sbt-microsites to display d
![Mocked Streams](https://mockedstreams.madewithtea.com/img/navbar_brand.png) | [**Mocked Streams**](https://mockedstreams.madewithtea.com) | Scala DSL for Unit-Testing Kafka Streams Topologies
![sbt-kubeyml](http://sbt-kubeyml.vaslabs.org/img/navbar_brand.png) | [**sbt-kubeyml**](http://sbt-kubeyml.vaslabs.org) | Typesafe Kubernetes manifests to deploy Scala applications

[comment]: # (Start Copyright)
# Copyright

sbt-microsites is designed and developed by 47 Degrees

Copyright (C) 2016-2020 47 Degrees. <http://47deg.com>

[comment]: # (End Copyright)
93 changes: 30 additions & 63 deletions build.sbt
Original file line number Diff line number Diff line change
@@ -1,92 +1,59 @@
inThisBuild(
List(
organization := "com.47deg",
scalaVersion := V.scala
)
)
ThisBuild / organization := "com.47deg"
ThisBuild / scalaVersion := "2.12.11"

addCommandAlias("ci-test", "scalafmtCheckAll; scalafmtSbtCheck; docs/tut; compile; test; scripted")
addCommandAlias("ci-docs", "project-docs/mdoc; headerCreateAll")
addCommandAlias("ci-microsite", "docs/publishMicrosite")
addCommandAlias(
"ci-test",
"scalafmtCheckAll; scalafmtSbtCheck; microsite/mdoc; compile; test; scripted"
)
addCommandAlias(
"ci-docs",
"github; documentation/mdoc; headerCreateAll; microsite/publishMicrosite"
)
addCommandAlias("ci-publish", "github; ci-release")

lazy val `sbt-microsites` = (project in file("."))
.settings(moduleName := "sbt-microsites")
.settings(pluginSettings: _*)
.enablePlugins(JekyllPlugin)
.enablePlugins(SbtPlugin)

lazy val docs = project
.settings(moduleName := "docs")
lazy val microsite = project
.settings(micrositeSettings: _*)
.settings(skip in publish := true)
.settings(
Seq(
buildInfoKeys := Seq[BuildInfoKey](name, version, scalaVersion, sbtVersion),
buildInfoPackage := "microsites"
): _*
)
.enablePlugins(MicrositesPlugin)
.enablePlugins(TutPlugin)
.enablePlugins(BuildInfoPlugin)
.enablePlugins(MdocPlugin)

lazy val `project-docs` = (project in file(".docs"))
.aggregate(`sbt-microsites`)
.dependsOn(`sbt-microsites`)
.settings(moduleName := "sbt-microsites-project-docs")
.settings(mdocIn := file(".docs"))
lazy val documentation = project
.settings(mdocOut := file("."))
.settings(skip in publish := true)
.enablePlugins(MdocPlugin)

lazy val V = new {
val ghPages: String = "0.6.3"
val github4s: String = "0.24.0"
val mdoc: String = "2.1.1"
val moultingyaml: String = "0.4.2"
val sbtSite: String = "1.4.0"
val scala: String = "2.12.11"
val scalatestScalacheck: String = "3.1.1.1"
val scalatags: String = "0.9.0"
val scrimage: String = "2.1.8"
val tut: String = "0.6.13"
}

lazy val pluginSettings: Seq[Def.Setting[_]] = Seq(
sbtPlugin := true,
resolvers ++= Seq(
Resolver.sonatypeRepo("snapshots"),
"jgit-repo" at "https://download.eclipse.org/jgit/maven"
),
addSbtPlugin("org.tpolecat" % "tut-plugin" % V.tut),
addSbtPlugin("org.scalameta" % "sbt-mdoc" % V.mdoc),
addSbtPlugin("com.typesafe.sbt" % "sbt-ghpages" % V.ghPages),
addSbtPlugin("com.typesafe.sbt" % "sbt-site" % V.sbtSite),
addSbtPlugin("org.tpolecat" % "tut-plugin" % "0.6.13"),
addSbtPlugin("org.scalameta" % "sbt-mdoc" % "2.1.1"),
addSbtPlugin("com.typesafe.sbt" % "sbt-ghpages" % "0.6.3"),
addSbtPlugin("com.typesafe.sbt" % "sbt-site" % "1.4.0"),
libraryDependencies ++= Seq(
"com.47deg" %% "github4s" % V.github4s,
"net.jcazevedo" %% "moultingyaml" % V.moultingyaml,
"com.lihaoyi" %% "scalatags" % V.scalatags,
"com.sksamuel.scrimage" %% "scrimage-core" % V.scrimage,
"org.scalatestplus" %% "scalacheck-1-14" % V.scalatestScalacheck % Test
"com.47deg" %% "github4s" % "0.24.0",
"net.jcazevedo" %% "moultingyaml" % "0.4.2",
"com.lihaoyi" %% "scalatags" % "0.9.0",
"com.sksamuel.scrimage" %% "scrimage-core" % "2.1.8",
"org.scalatestplus" %% "scalacheck-1-14" % "3.1.1.1" % Test
),
scriptedLaunchOpts := {
scriptedLaunchOpts.value ++
Seq(
"-Xmx2048M",
"-XX:ReservedCodeCacheSize=256m",
"-XX:+UseConcMarkSweepGC",
"-Dplugin.version=" + version.value,
"-Dscala.version=" + scalaVersion.value
)
}
scriptedLaunchOpts ++= Seq(
"-Xmx2048M",
"-XX:ReservedCodeCacheSize=256m",
"-XX:+UseConcMarkSweepGC",
"-Dplugin.version=" + version.value,
"-Dscala.version=" + scalaVersion.value
)
)

lazy val micrositeSettings: Seq[Def.Setting[_]] = Seq(
micrositeName := "sbt-microsites",
micrositeDescription := "An sbt plugin to create awesome microsites for your project",
micrositeBaseUrl := "sbt-microsites",
micrositeDocumentationUrl := "docs",
micrositeGithubOwner := "47degrees",
micrositeGithubRepo := "sbt-microsites",
micrositeGithubToken := sys.env.get("GITHUB_TOKEN"),
micrositePushSiteWith := GitHub4s,
includeFilter in makeSite := "*.html" | "*.css" | "*.png" | "*.jpg" | "*.gif" | "*.js" | "*.swf" | "*.md" | "*.svg"
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading