@zio.dev/zio-sbt 0.6.0 → 0.6.3
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/index.md +35 -5
- 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.6.
|
|
16
|
-
addSbtPlugin("dev.zio" % "zio-sbt-ci" % "0.6.
|
|
17
|
-
addSbtPlugin("dev.zio" % "zio-sbt-website" % "0.6.
|
|
15
|
+
addSbtPlugin("dev.zio" % "zio-sbt-ecosystem" % "0.6.3")
|
|
16
|
+
addSbtPlugin("dev.zio" % "zio-sbt-ci" % "0.6.3")
|
|
17
|
+
addSbtPlugin("dev.zio" % "zio-sbt-website" % "0.6.3")
|
|
18
18
|
```
|
|
19
19
|
|
|
20
20
|
Then you can enable them by using the following code in your `build.sbt` file:
|
|
@@ -101,7 +101,7 @@ ZIO SBT CI plugin generates a default GitHub workflow that includes common CI ta
|
|
|
101
101
|
To use ZIO SBT CI plugin, add the following lines to your `plugins.sbt` file:
|
|
102
102
|
|
|
103
103
|
```scala
|
|
104
|
-
addSbtPlugin("dev.zio" % "zio-sbt-ci" % "0.6.
|
|
104
|
+
addSbtPlugin("dev.zio" % "zio-sbt-ci" % "0.6.3")
|
|
105
105
|
|
|
106
106
|
resolvers ++= Resolver.sonatypeOssRepos("public")
|
|
107
107
|
```
|
|
@@ -129,6 +129,36 @@ This will generate a GitHub workflow file inside the `.github/workflows` directo
|
|
|
129
129
|
>
|
|
130
130
|
> To use this plugin, we also need to install [ZIO Assistant](https://github.com/apps/zio-assistant) bot.
|
|
131
131
|
|
|
132
|
+
### Auto-Approving and Auto-Merging Dependency Update PRs
|
|
133
|
+
|
|
134
|
+
Besides `ci.yml`, the `ciGenerateGithubWorkflow` task also generates two more workflow files: `auto-approve.yml` and `auto-merge.yml`. These workflows automatically approve and enable GitHub's native auto-merge (squash strategy) on 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).
|
|
135
|
+
|
|
136
|
+
Both workflows trigger on `pull_request_target` and also support `workflow_dispatch`, which backfills the approval/auto-merge on every currently open PR from the configured bots—handy for recovering PRs that were opened before the workflow existed, or after a workflow bug is fixed.
|
|
137
|
+
|
|
138
|
+
The set of trusted bots is controlled by the `ciDependencyUpdateBots` setting, which takes a `Seq[DependencyBot]`:
|
|
139
|
+
|
|
140
|
+
```scala
|
|
141
|
+
import zio.sbt.githubactions.DependencyBot
|
|
142
|
+
|
|
143
|
+
ciDependencyUpdateBots := Seq(
|
|
144
|
+
DependencyBot.Dependabot,
|
|
145
|
+
DependencyBot.Renovate,
|
|
146
|
+
DependencyBot.ScalaSteward("zio-scala-steward"),
|
|
147
|
+
DependencyBot.Custom("some-other-bot[bot]")
|
|
148
|
+
)
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
- `DependencyBot.Dependabot` — matches login `dependabot[bot]`
|
|
152
|
+
- `DependencyBot.Renovate` — matches login `renovate[bot]`
|
|
153
|
+
- `DependencyBot.ScalaSteward(githubAppName)` — matches login `<githubAppName>[bot]`, where `githubAppName` is the name of the GitHub App you registered for Scala Steward
|
|
154
|
+
- `DependencyBot.Custom(login)` — matches any exact GitHub login, for bots not covered by the predefined cases
|
|
155
|
+
|
|
156
|
+
The default value mirrors the bots used by the `zio/zio` repository: `Seq(DependencyBot.Dependabot, DependencyBot.Renovate, DependencyBot.ScalaSteward("zio-scala-steward"))`. If your Scala Steward GitHub App has a different name, override the setting with the correct `ScalaSteward` app name.
|
|
157
|
+
|
|
158
|
+
> **Note:**
|
|
159
|
+
>
|
|
160
|
+
> For `gh pr merge --auto` to actually merge a PR (rather than just queue it), the target repository needs "Allow auto-merge" enabled under **Settings → General**, and branch protection with required status checks configured on the target branch.
|
|
161
|
+
|
|
132
162
|
## ZIO SBT Source
|
|
133
163
|
|
|
134
164
|
ZIO SBT Source is a Scala 2.13 + Scala 3 cross-compiled library that provides utilities for self-documenting example code. It includes the `ExprEval` macro, which captures the source text of expressions at compile time and prints them alongside their evaluated results at runtime.
|
|
@@ -138,7 +168,7 @@ ZIO SBT Source is a Scala 2.13 + Scala 3 cross-compiled library that provides ut
|
|
|
138
168
|
Add the following line to your `libraryDependencies` in `build.sbt`:
|
|
139
169
|
|
|
140
170
|
```scala
|
|
141
|
-
libraryDependencies += "dev.zio" %% "zio-sbt-source" % "0.6.
|
|
171
|
+
libraryDependencies += "dev.zio" %% "zio-sbt-source" % "0.6.3"
|
|
142
172
|
```
|
|
143
173
|
|
|
144
174
|
### Features
|