Skip to content

Commit 5eb4187

Browse files
committed
Update documentation
1 parent 6534350 commit 5eb4187

File tree

4 files changed

+29
-33
lines changed

4 files changed

+29
-33
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# Scala2PlantUML
22

3-
[![Continuous Integration](https://github.com/BotTech/scala2plantuml/actions/workflows/ci.yml/badge.svg)](https://github.com/BotTech/scala2plantuml/actions/workflows/ci.yml)
4-
![Scala2PlantUML Version](https://img.shields.io/maven-central/v/nz.co.bottech/scala2plantuml_2.13?label=Scala2PlantUML)
3+
[![Build badge](https://img.shields.io/github/workflow/status/BotTech/scala2plantuml/Continuous%20Integration/main)](https://github.com/BotTech/scala2plantuml/actions/workflows/ci.yml)
4+
[![Maven-Central badge](https://img.shields.io/maven-central/v/nz.co.bottech/scala2plantuml_2.13)](https://search.maven.org/search?q=g:nz.co.bottech%20a:*scala2plantuml*)
5+
[![Scala Steward badge](https://img.shields.io/badge/Scala_Steward-helping-blue.svg?style=flat&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAQCAMAAAARSr4IAAAAVFBMVEUAAACHjojlOy5NWlrKzcYRKjGFjIbp293YycuLa3pYY2LSqql4f3pCUFTgSjNodYRmcXUsPD/NTTbjRS+2jomhgnzNc223cGvZS0HaSD0XLjbaSjElhIr+AAAAAXRSTlMAQObYZgAAAHlJREFUCNdNyosOwyAIhWHAQS1Vt7a77/3fcxxdmv0xwmckutAR1nkm4ggbyEcg/wWmlGLDAA3oL50xi6fk5ffZ3E2E3QfZDCcCN2YtbEWZt+Drc6u6rlqv7Uk0LdKqqr5rk2UCRXOk0vmQKGfc94nOJyQjouF9H/wCc9gECEYfONoAAAAASUVORK5CYII=)](https://scala-steward.org)
56

67
Scala2PlantUML generates [PlantUML] diagrams from Scala code.
78

@@ -52,6 +53,7 @@ cs install --channel https://git.io/Jqv1i scala2plantuml
5253
### Usage
5354

5455
```text
56+
> scala2plantuml --help
5557
Scala2PlantUML version 0.1.12
5658
Usage: scala2plantuml [options] symbol
5759

build.sbt

Lines changed: 17 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,26 @@ val scoptVersion = "4.0.0"
88
val slf4jVersion = "1.7.30"
99
val utestVersion = "0.7.7"
1010

11-
val checkTasks = List(
12-
"scalafmtCheckAll",
13-
"scalastyle",
14-
"versionPolicyCheck",
15-
"githubWorkflowCheck",
16-
"mdocCheck",
17-
"evicted",
18-
"undeclaredCompileDependenciesTest",
19-
"unusedCompileDependenciesTest",
20-
"dependencyCheckAggregate",
21-
"test",
22-
"scripted"
11+
addCommandAlias(
12+
"devCheck",
13+
supportedScalaVersions.flatMap { version =>
14+
s"++$version" :: "check" :: (if (version == scala213) Nil else List("scripted"))
15+
}.mkString(";")
2316
)
2417

2518
addCommandAlias(
2619
"check",
27-
supportedScalaVersions.flatMap { version =>
28-
s"++$version" :: checkTasks.filterNot(_ == "scripted" && version == scala213)
29-
}.mkString("; ")
20+
List(
21+
"scalafmtCheckAll",
22+
"scalastyle",
23+
"versionPolicyCheck",
24+
"mdocCheck",
25+
"evicted",
26+
"undeclaredCompileDependenciesTest",
27+
"unusedCompileDependenciesTest",
28+
"dependencyCheckAggregate",
29+
"test"
30+
).mkString(";")
3031
)
3132

3233
addCommandAlias(
@@ -58,19 +59,7 @@ inThisBuild(
5859
organization := "nz.co.bottech",
5960
organizationName := "BotTech",
6061
githubWorkflowBuild := List(
61-
WorkflowStep.Sbt(List("scalafmtCheckAll", "scalastyle"), name = Some("Check formatting and style")),
62-
WorkflowStep.Sbt(List("versionPolicyCheck"), name = Some("Check version adheres to the policy")),
63-
WorkflowStep.Sbt(List("mdocCheck"), name = Some("Check documentation has been generated")),
64-
WorkflowStep.Sbt(
65-
List(
66-
"evicted",
67-
"undeclaredCompileDependenciesTest",
68-
"unusedCompileDependenciesTest",
69-
"dependencyCheckAggregate"
70-
),
71-
name = Some("Check dependencies")
72-
),
73-
WorkflowStep.Sbt(List("test"), name = Some("Build and test")),
62+
WorkflowStep.Sbt(List("check"), name = Some("Build, test and check libraries")),
7463
WorkflowStep.Sbt(
7564
List("scripted"),
7665
name = Some("Build and test sbt plugin"),

docs/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# Scala2PlantUML
22

3-
[![Continuous Integration](https://github.com/BotTech/scala2plantuml/actions/workflows/ci.yml/badge.svg)](https://github.com/BotTech/scala2plantuml/actions/workflows/ci.yml)
4-
![Scala2PlantUML Version](https://img.shields.io/maven-central/v/nz.co.bottech/scala2plantuml_2.13?label=Scala2PlantUML)
3+
[![Build badge](https://img.shields.io/github/workflow/status/BotTech/scala2plantuml/Continuous%20Integration/main)](https://github.com/BotTech/scala2plantuml/actions/workflows/ci.yml)
4+
[![Maven-Central badge](https://img.shields.io/maven-central/v/nz.co.bottech/scala2plantuml_2.13)](https://search.maven.org/search?q=g:nz.co.bottech%20a:*scala2plantuml*)
5+
[![Scala Steward badge](https://img.shields.io/badge/Scala_Steward-helping-blue.svg?style=flat&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAQCAMAAAARSr4IAAAAVFBMVEUAAACHjojlOy5NWlrKzcYRKjGFjIbp293YycuLa3pYY2LSqql4f3pCUFTgSjNodYRmcXUsPD/NTTbjRS+2jomhgnzNc223cGvZS0HaSD0XLjbaSjElhIr+AAAAAXRSTlMAQObYZgAAAHlJREFUCNdNyosOwyAIhWHAQS1Vt7a77/3fcxxdmv0xwmckutAR1nkm4ggbyEcg/wWmlGLDAA3oL50xi6fk5ffZ3E2E3QfZDCcCN2YtbEWZt+Drc6u6rlqv7Uk0LdKqqr5rk2UCRXOk0vmQKGfc94nOJyQjouF9H/wCc9gECEYfONoAAAAASUVORK5CYII=)](https://scala-steward.org)
56

67
Scala2PlantUML generates [PlantUML] diagrams from Scala code.
78

@@ -52,6 +53,7 @@ cs install --channel https://git.io/Jqv1i scala2plantuml
5253
### Usage
5354

5455
```text
56+
> scala2plantuml --help
5557
Scala2PlantUML version @VERSION@
5658
Usage: scala2plantuml [options] symbol
5759

project/plugins.sbt

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,7 @@ addSbtPlugin("org.scalastyle" %% "scalastyle-sbt-plugin" % "1.0.0"
1111
addSbtPlugin("org.wartremover" % "sbt-wartremover" % "2.4.13")
1212

1313
lazy val root = (project in file(".")).dependsOn(sonatypePlugin)
14-
lazy val sonatypePlugin = RootProject(uri("git://github.com/steinybot/sbt-sonatype#5a0ace0551b5d58debbf4aae4a1b5f9b5d888ef1"))
14+
15+
lazy val sonatypePlugin = RootProject(
16+
uri("git://github.com/steinybot/sbt-sonatype#5a0ace0551b5d58debbf4aae4a1b5f9b5d888ef1")
17+
)

0 commit comments

Comments
 (0)