@zio.dev/zio-sbt 0.8.8 → 0.8.10

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 +23 -11
  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.8.8")
16
- addSbtPlugin("dev.zio" % "zio-sbt-ci" % "0.8.8")
17
- addSbtPlugin("dev.zio" % "zio-sbt-website" % "0.8.8")
15
+ addSbtPlugin("dev.zio" % "zio-sbt-ecosystem" % "0.8.10")
16
+ addSbtPlugin("dev.zio" % "zio-sbt-ci" % "0.8.10")
17
+ addSbtPlugin("dev.zio" % "zio-sbt-website" % "0.8.10")
18
18
  ```
19
19
 
20
20
  Then you can enable them by using the following code in your `build.sbt` file:
@@ -130,7 +130,7 @@ ZIO SBT CI plugin generates a default GitHub workflow that includes common CI ta
130
130
  To use ZIO SBT CI plugin, add the following lines to your `plugins.sbt` file:
131
131
 
132
132
  ```scala
133
- addSbtPlugin("dev.zio" % "zio-sbt-ci" % "0.8.8")
133
+ addSbtPlugin("dev.zio" % "zio-sbt-ci" % "0.8.10")
134
134
 
135
135
  resolvers ++= Resolver.sonatypeOssRepos("public")
136
136
  ```
@@ -157,7 +157,7 @@ This will generate a GitHub workflow file inside the `.github/workflows` directo
157
157
  | `update-readme` | Regenerates `README.md` from `docs/index.md` and opens a PR |
158
158
  | `ci` | Aggregate gate: succeeds only if the jobs above did. Point branch protection at this one |
159
159
  | `release` | Runs `sbt ci-release` on a published release, and on pushes to enabled branches for SNAPSHOTs |
160
- | `release-docs` | Publishes the docs to npm |
160
+ | `release-docs` | Publishes the docs to npm after a successful `release`, or on a manual run with `docs-only` set to `true` |
161
161
  | `notify-docs-release` | Tells `zio/zio` to rebuild the docs site |
162
162
 
163
163
  Note that the plugin declares `trigger = allRequirements`, so having it on the classpath is enough — `enablePlugins(ZioSbtCiPlugin)` is not strictly required. Its settings are defined at `ThisBuild` level, so set them as `ThisBuild / ciSomething := ...`, or inside `inThisBuild(...)`.
@@ -166,6 +166,22 @@ Note that the plugin declares `trigger = allRequirements`, so having it on the c
166
166
  >
167
167
  > To use this plugin, we also need to install [ZIO Assistant](https://github.com/apps/zio-assistant) bot.
168
168
 
169
+ ### Publishing a Release's Docs Again
170
+
171
+ `release-docs` needs `release`, and Maven Central rejects a version it already has. So when `release` has published a version but `release-docs` failed (for example, because the npm package was not set up yet), running `release` again fails with `already exists` and the docs are skipped again.
172
+
173
+ To publish the docs without the Maven release, run the CI workflow by hand with the `docs-only` input set to `true`:
174
+
175
+ ```bash
176
+ gh workflow run ci.yml --ref main -f docs-only=true
177
+ ```
178
+
179
+ Or open **Actions → CI → Run workflow**, pick the branch, and type `true` in `docs-only`. The `release` job is skipped, `release-docs` publishes the docs, and `notify-docs-release` runs once they are published. The docs version is the newest `v*` tag in the repository; the docs content comes from the branch or tag the workflow runs on.
180
+
181
+ The run uses the `ci.yml` of that branch or tag, so the input is only there once the workflow has been regenerated with this version of the plugin. Every `workflow_dispatch` trigger of `ci.yml` gets the input, including one in a custom `ciWorkflowTriggers`, as long as the workflow has a `release-docs` job.
182
+
183
+ If the failure is caught right away, **Re-run failed jobs** on the original run also works: it keeps the successful `release` result and only runs `release-docs` and `notify-docs-release` again. **Re-run all jobs** runs `release` again and fails.
184
+
169
185
  ### Auto-Approving and Auto-Merging Dependency Update PRs
170
186
 
171
187
  Besides `ci.yml`, the `ciGenerateGithubWorkflow` task also generates two more workflow files: `auto-approve.yml` and `auto-merge.yml`. These workflows automatically approve, and squash-merge once CI is green, pull requests opened by dependency-update bots, such as [Scala Steward](https://github.com/scala-steward-org/scala-steward), [Dependabot](https://github.com/dependabot), and [Renovate](https://github.com/renovatebot/renovate).
@@ -445,7 +461,7 @@ produce, so replacing `test` with `integration-test` above is enough on its own.
445
461
  ciPullRequestApprovalJobs := Seq("lint", "integration-test")
446
462
  ```
447
463
 
448
- `Checkout`, `SetupLibuv`, `SetupJava(version)`, `SetupSBT`, `CacheDependencies`, `SetupNodeJs` and `SetSwapSpace` are all available; the ones defined as settings need `.value`.
464
+ `Checkout`, `SetupJava(version)`, `SetupSBT`, `CacheDependencies`, `SetupNodeJs` and `SetSwapSpace` are all available; the ones defined as settings need `.value`. (`SetupLibuv` is deprecated and no longer used by the generated jobs; Scala Native does not need libuv, so drop it from custom jobs.)
449
465
 
450
466
  ### A Workflow of Only Custom Jobs
451
467
 
@@ -548,7 +564,7 @@ ZIO SBT Source is a Scala 2.13 + Scala 3 cross-compiled library that provides ut
548
564
  Add the following line to your `libraryDependencies` in `build.sbt`:
549
565
 
550
566
  ```scala
551
- libraryDependencies += "dev.zio" %% "zio-sbt-source" % "0.8.8"
567
+ libraryDependencies += "dev.zio" %% "zio-sbt-source" % "0.8.10"
552
568
  ```
553
569
 
554
570
  ### Features
@@ -666,8 +682,6 @@ test:
666
682
  matrix:
667
683
  java: ['17', '21', '25']
668
684
  steps:
669
- - name: Install libuv
670
- run: sudo apt-get update && sudo apt-get install -y libuv1-dev
671
685
  - name: Setup Scala
672
686
  uses: actions/setup-java@v5
673
687
  with:
@@ -735,8 +749,6 @@ test:
735
749
  - ++2.13.18 submoduleB
736
750
  - ++3.3.7 submoduleB
737
751
  steps:
738
- - name: Install libuv
739
- run: sudo apt-get update && sudo apt-get install -y libuv1-dev
740
752
  - name: Setup Scala
741
753
  uses: actions/setup-java@v5
742
754
  with:
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.8.8",
5
+ "version": "0.8.10",
6
6
  "repository": {
7
7
  "url": "https://github.com/zio/zio-sbt"
8
8
  }