@zio.dev/zio-sbt 0.1.5 → 0.1.6
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.
- package/developer-notes.md +3 -0
- package/index.md +5 -19
- package/package.json +1 -1
package/developer-notes.md
CHANGED
|
@@ -7,4 +7,7 @@ title: "Developer Notes"
|
|
|
7
7
|
|
|
8
8
|
### ZIO SBT Website
|
|
9
9
|
- Add a command to make a version history page in documentation
|
|
10
|
+
- Check if the committed workflow is valid or not.
|
|
11
|
+
- To generate README.md file, it doesn't need to compile all docs.
|
|
12
|
+
- Add env variable for zio version (ZIO_VERSION).
|
|
10
13
|
|
package/index.md
CHANGED
|
@@ -5,17 +5,16 @@ title: "ZIO SBT"
|
|
|
5
5
|
|
|
6
6
|
_ZIO SBT_ is an sbt plugin for ZIO projects. It provides high-level SBT utilities that simplify the development of ZIO applications.
|
|
7
7
|
|
|
8
|
-
|
|
|
9
|
-
|
|
10
|
-
|
|
|
11
|
-
|
|
8
|
+
|Project Stage | CI | Release | Snapshot | Discord | Github |
|
|
9
|
+
|--------------|----|---------|----------|---------|--------|
|
|
10
|
+
|[](https://github.com/zio/zio/wiki/Project-Stages) | |[](https://oss.sonatype.org/content/repositories/releases/dev/zio/zio-sbt-website_2.12/) |[](https://oss.sonatype.org/content/repositories/snapshots/dev/zio/zio-sbt-website_2.12/) |[](https://discord.gg/2ccFBr4) |[](https://github.com/zio/zio-sbt) |
|
|
12
11
|
|
|
13
12
|
## Installation
|
|
14
13
|
|
|
15
14
|
Add the following lines to your `plugin.sbt` file:
|
|
16
15
|
|
|
17
16
|
```scala
|
|
18
|
-
addSbtPlugin("dev.zio" % "zio-sbt-website" % "0.1.
|
|
17
|
+
addSbtPlugin("dev.zio" % "zio-sbt-website" % "0.1.6")
|
|
19
18
|
```
|
|
20
19
|
|
|
21
20
|
Then you can enable it by using the following code in your `build.sbt` file:
|
|
@@ -33,17 +32,4 @@ ZIO SBT Website is an SBT plugin that has the following tasks:
|
|
|
33
32
|
- `sbt previewWebsite`— runs a local webserver that serves documentation locally on http://localhost:3000. By changing the documentation inside the `docs` directory, the website will be reloaded with new content.
|
|
34
33
|
- `sbt publishToNpm`— publishes documentation inside the `docs` directory to the npm registry.
|
|
35
34
|
- `sbt generateGithubWorkflow`— generates GitHub workflow which publishes documentation for each library release.
|
|
36
|
-
- `sbt generateReadme`— generate README.md file
|
|
37
|
-
|
|
38
|
-
[Badge-CI]: https://github.com/zio/zio-sbt/workflows/CI/badge.svg
|
|
39
|
-
[Badge-SonatypeReleases]: https://img.shields.io/nexus/r/https/oss.sonatype.org/dev.zio/zio-sbt-website_2.12.svg "Sonatype Releases"
|
|
40
|
-
[Badge-SonatypeSnapshots]: https://img.shields.io/nexus/s/https/oss.sonatype.org/dev.zio/zio-sbt-website_2.12.svg "Sonatype Snapshots"
|
|
41
|
-
[Badge-Discord]: https://img.shields.io/discord/629491597070827530?logo=discord "chat on discord"
|
|
42
|
-
[Link-SonatypeReleases]: https://oss.sonatype.org/content/repositories/releases/dev/zio/zio-sbt_2.12_1.0/ "Sonatype Releases"
|
|
43
|
-
[Link-SonatypeSnapshots]: https://oss.sonatype.org/content/repositories/snapshots/dev/zio/zio-sbt-website_2.12_1.0/ "Sonatype Snapshots"
|
|
44
|
-
[badge-iim]: https://isitmaintained.com/badge/resolution/zio/zio-sbt.svg
|
|
45
|
-
[link-iim]: https://isitmaintained.com/project/zio/zio-sbt
|
|
46
|
-
[badge-discord]: https://img.shields.io/discord/630498701860929559?logo=discord "chat ondiscord"
|
|
47
|
-
[link-discord]: https://discord.gg/2ccFBr4 "Discord"
|
|
48
|
-
[Stage]: https://img.shields.io/badge/Project%20Stage-Development-yellowgreen.svg
|
|
49
|
-
[Stage-Page]: https://github.com/zio/zio/wiki/Project-Stages
|
|
35
|
+
- `sbt generateReadme`— generate README.md file.
|
package/package.json
CHANGED