refactor: migrate to zio-json + update all #438

ThijsBroersen · 2024-10-17T20:21:56Z

Why circe if we have zio-json? 😏

I think main is broken because some PR's got merged which did not pass CI. Like circe-yaml 0.16.0 which is not available for Scala 2.12 anymore.

This PR updates all dependencies and migrates to zio-json. I see some other areas where improvements can be made but will target that in separate PR's.

I ran sbt prepare as in the Contributing guide but not sbt testPlugin that seems broken. I could not find any reference to the testPlugin task. I also could not find any tests in the repo... how is this project tested? Manually?

With zio-json I created codecs (both encoders and decoders) so perhaps validations can now also be done by parsing the yaml and decoding back to the model and then create a set of rules for it. Perhaps even allow manual tweaks and on each new generate-run first load the existing flow and then update this flow.

ThijsBroersen · 2024-10-17T20:56:37Z

The PR is btw breaking because it changes the model so the codecs become easier because they match the GHA model more closely. Any opinions?
I think it helps to migrate and not have to remember different views on the same thing.

--update--
I restored the existing model and added a new one. With toNative methods to convert. I tested it on a few zio projects and the required changes are quite small.

ThijsBroersen · 2024-10-17T21:11:48Z

zio-sbt-ecosystem/src/main/scala/zio/sbt/ScalaCompilerSettings.scala

@@ -190,7 +190,7 @@ trait ScalaCompilerSettings {
            )
          } else Seq.empty
        },
-        Test / parallelExecution := scalaBinaryVersion.value != "3",
+        Test / parallelExecution := scalaBinaryVersion.value != "3", // why not parallel execution for Scala 3?


Discovered this setting.. why was this set? I would prefer to not have this set.

ThijsBroersen · 2024-10-17T21:12:37Z

zio-sbt-ecosystem/src/main/scala/zio/sbt/ScalaCompilerSettings.scala

@@ -233,8 +233,7 @@ trait ScalaCompilerSettings {
           libraryDependencies ++= Seq(
             "dev.zio" %%% "zio-test"     % ZioSbtEcosystemPlugin.autoImport.zioVersion.value % Test,
             "dev.zio" %%% "zio-test-sbt" % ZioSbtEcosystemPlugin.autoImport.zioVersion.value % Test
-           ),
-           testFrameworks += new TestFramework("zio.test.sbt.ZTestFramework")
+           )


For quite some time ZTestFramework is added to testFrameworks in sbt by default.

guizmaii · 2024-10-19T23:53:42Z

project/Versions.scala

+  val Scala212 = "2.12.20"
+  val Scala213 = "2.13.15"
+  val Scala3   = "3.3.4"
+  val zio      = "2.1.9"


Suggested change

val zio = "2.1.9"

val zio = "2.1.11"

guizmaii · 2024-10-19T23:54:09Z

project/plugins.sbt

-libraryDependencies += "dev.zio"      %% "zio"              % "2.1.8"
-libraryDependencies += "io.circe"     %% "circe-yaml"       % "0.16.0"
+libraryDependencies += "org.snakeyaml" % "snakeyaml-engine" % "2.8"
+libraryDependencies += "dev.zio"      %% "zio"              % "2.1.9"


Suggested change

libraryDependencies += "dev.zio" %% "zio" % "2.1.9"

libraryDependencies += "dev.zio" %% "zio" % "2.1.11"

guizmaii · 2024-10-19T23:54:16Z

zio-sbt-ci/build.sbt

@@ -1,2 +1,3 @@
-libraryDependencies += "dev.zio"  %% "zio"        % "2.1.8"
-libraryDependencies += "io.circe" %% "circe-yaml" % "0.16.0"
+libraryDependencies += "dev.zio" %% "zio"           % "2.1.9"


Suggested change

libraryDependencies += "dev.zio" %% "zio" % "2.1.9"

libraryDependencies += "dev.zio" %% "zio" % "2.1.11"

guizmaii · 2024-10-19T23:54:31Z

zio-sbt-ecosystem/build.sbt

-libraryDependencies += "org.snakeyaml" % "snakeyaml-engine" % "2.7"
-libraryDependencies += "dev.zio"      %% "zio"              % "2.1.8"
-libraryDependencies += "io.circe"     %% "circe-yaml"       % "0.16.0"
+libraryDependencies += "dev.zio" %% "zio"           % "2.1.9"


Suggested change

libraryDependencies += "dev.zio" %% "zio" % "2.1.9"

libraryDependencies += "dev.zio" %% "zio" % "2.1.11"

guizmaii · 2024-10-19T23:55:00Z

zio-sbt-ecosystem/src/main/scala/zio/sbt/Versions.scala


-  val zioVersion = "2.0.21"
+  val zioVersion = "2.1.9"


Suggested change

val zioVersion = "2.1.9"

val zioVersion = "2.1.11"

guizmaii · 2024-10-19T23:55:14Z

zio-sbt-githubactions/build.sbt

@@ -1,2 +1,3 @@
-libraryDependencies += "dev.zio"  %% "zio"        % "2.1.8"
-libraryDependencies += "io.circe" %% "circe-yaml" % "0.16.0"
+libraryDependencies += "dev.zio" %% "zio"           % "2.1.9"


Suggested change

libraryDependencies += "dev.zio" %% "zio" % "2.1.9"

libraryDependencies += "dev.zio" %% "zio" % "2.1.11"

guizmaii · 2024-10-19T23:56:50Z

zio-sbt-githubactions/src/main/scala/zio/sbt/githubactionsnative/ScalaWorkflow.scala

+
+// The original code of the githubactions package was originally copied from the zio-aws-codegen project:
+// https://github.com/zio/zio-aws/tree/master/zio-aws-codegen/src/main/scala/zio/aws/codegen/githubactions
+object ScalaWorkflow {


What's the need to rewrite this code from scratch?

I added the new solution next to the existing. But I think in the end result the old model and workflow are not used anymore in the other modules.
Perhaps the question should be: should we use the new model, stick with the old or somehow support both?
My reasons for the new model is that it is closer to writing direct GHA yaml and less of a cognitive load (no need to learn another DSL). It also simplifies the codecs because we reduce the amount of codec adjustments or required DTO's.

ThijsBroersen changed the title ~~refactor: migrate to zio-json~~ refactor: migrate to zio-json + update all Oct 17, 2024

ThijsBroersen mentioned this pull request Oct 17, 2024

Feature: support sbt-projectmatrix #439

Open

refactor: migrate to zio-json

b2a7d1a

ThijsBroersen force-pushed the refactor/migrate-to-zio-json branch from 7a9a6c8 to b2a7d1a Compare October 17, 2024 20:27

ThijsBroersen commented Oct 17, 2024

View reviewed changes

add githubactionsnative model, restore old models

eb7e7a8

ThijsBroersen force-pushed the refactor/migrate-to-zio-json branch from ba39433 to eb7e7a8 Compare October 18, 2024 21:38

guizmaii reviewed Oct 19, 2024

View reviewed changes

ThijsBroersen added 2 commits October 20, 2024 14:38

use latest zio version

60af4ba

scalafix

562f690

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: migrate to zio-json + update all #438

refactor: migrate to zio-json + update all #438

ThijsBroersen commented Oct 17, 2024

ThijsBroersen commented Oct 17, 2024 •

edited

Loading

ThijsBroersen Oct 17, 2024

ThijsBroersen Oct 17, 2024

guizmaii Oct 19, 2024

guizmaii Oct 19, 2024

guizmaii Oct 19, 2024

guizmaii Oct 19, 2024

guizmaii Oct 19, 2024

guizmaii Oct 19, 2024

guizmaii Oct 19, 2024 •

edited

Loading

ThijsBroersen Oct 20, 2024

	libraryDependencies += "dev.zio" %% "zio" % "2.1.9"
	libraryDependencies += "dev.zio" %% "zio" % "2.1.11"

refactor: migrate to zio-json + update all #438

Are you sure you want to change the base?

refactor: migrate to zio-json + update all #438

Conversation

ThijsBroersen commented Oct 17, 2024

ThijsBroersen commented Oct 17, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

guizmaii Oct 19, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ThijsBroersen commented Oct 17, 2024 •

edited

Loading

guizmaii Oct 19, 2024 •

edited

Loading