@zio.dev/zio-sbt 0.7.0 → 0.7.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.md +21 -7
  2. package/package.json +1 -1
package/index.md CHANGED
@@ -12,9 +12,9 @@ _ZIO SBT_ contains multiple sbt plugins that are useful for ZIO projects. It pro
12
12
  Add the following lines to your `project/plugins.sbt` file:
13
13
 
14
14
  ```scala
15
- addSbtPlugin("dev.zio" % "zio-sbt-ecosystem" % "0.7.0")
16
- addSbtPlugin("dev.zio" % "zio-sbt-ci" % "0.7.0")
17
- addSbtPlugin("dev.zio" % "zio-sbt-website" % "0.7.0")
15
+ addSbtPlugin("dev.zio" % "zio-sbt-ecosystem" % "0.7.2")
16
+ addSbtPlugin("dev.zio" % "zio-sbt-ci" % "0.7.2")
17
+ addSbtPlugin("dev.zio" % "zio-sbt-website" % "0.7.2")
18
18
  ```
19
19
 
20
20
  Then you can enable them by using the following code in your `build.sbt` file:
@@ -88,6 +88,20 @@ ZIO SBT Website is an SBT plugin that has the following tasks:
88
88
  - `sbt publishToNpm`— publishes documentation inside the `docs` directory to the npm registry.
89
89
  - `sbt generateReadme`— generate README.md file from `docs/index.md` and sbt setting keys.
90
90
 
91
+ `website/docs` is generated output, not source. `mdocOut` points there, so `compileDocs` — and
92
+ anything that sequences it, including `generateReadme` — writes compiled documentation into it.
93
+ Add it to `.gitignore`:
94
+
95
+ ```gitignore
96
+ /website/docs
97
+ /website/build
98
+ /website/node_modules
99
+ /website/.docusaurus
100
+ ```
101
+
102
+ Committing `website/docs` leaves a `website` directory that holds generated output but no
103
+ Docusaurus scaffold, and `buildWebsite` then has no `package.json` to install from.
104
+
91
105
  ## ZIO SBT CI Plugin
92
106
 
93
107
  ZIO SBT CI is an sbt plugin which generates a GitHub workflow for a project, making it easier to set up continuous integration (CI) pipelines for Scala projects. With this plugin, developers can streamline their development workflow by automating the testing and deployment process, reducing manual effort and errors. The plugin is designed to work seamlessly with sbt, the popular build tool for Scala projects, and integrates smoothly with GitHub Actions, the CI/CD platform provided by GitHub.
@@ -101,7 +115,7 @@ ZIO SBT CI plugin generates a default GitHub workflow that includes common CI ta
101
115
  To use ZIO SBT CI plugin, add the following lines to your `plugins.sbt` file:
102
116
 
103
117
  ```scala
104
- addSbtPlugin("dev.zio" % "zio-sbt-ci" % "0.7.0")
118
+ addSbtPlugin("dev.zio" % "zio-sbt-ci" % "0.7.2")
105
119
 
106
120
  resolvers ++= Resolver.sonatypeOssRepos("public")
107
121
  ```
@@ -380,7 +394,7 @@ ZIO SBT Source is a Scala 2.13 + Scala 3 cross-compiled library that provides ut
380
394
  Add the following line to your `libraryDependencies` in `build.sbt`:
381
395
 
382
396
  ```scala
383
- libraryDependencies += "dev.zio" %% "zio-sbt-source" % "0.7.0"
397
+ libraryDependencies += "dev.zio" %% "zio-sbt-source" % "0.7.2"
384
398
  ```
385
399
 
386
400
  ### Features
@@ -513,7 +527,7 @@ test:
513
527
  with:
514
528
  fetch-depth: '0'
515
529
  - name: Test
516
- run: sbt +test
530
+ run: sbt --no-colors +test
517
531
  ```
518
532
 
519
533
  The `sbt +test` command will run the `test` task for all submodules in the project against all Scala versions defined in the `crossScalaVersions` setting.
@@ -582,5 +596,5 @@ test:
582
596
  with:
583
597
  fetch-depth: '0'
584
598
  - name: Test
585
- run: sbt ${{ matrix.scala-project }}/test
599
+ run: sbt --no-colors ${{ matrix.scala-project }}/test
586
600
  ```
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@zio.dev/zio-sbt",
3
3
  "description": "ZIO SBT Documentation",
4
4
  "license": "Apache-2.0",
5
- "version": "0.7.0",
5
+ "version": "0.7.2",
6
6
  "repository": {
7
7
  "url": "https://github.com/zio/zio-sbt"
8
8
  }