[PER-123] - improvement/ project template proposal #3

miguelemosreverte · 2022-04-25T15:08:42Z

Ticket

https://jira/PER-123

Description

This is the project template

Types of changes

Refactor (non-breaking change which makes the codebase beautiful)
Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

I have updated the documentation accordingly.
I have added tests to cover my changes.
All new and existing tests passed.

…le, project/target

My code follows the code style of this project. My change requires a change to the documentation.

Add PR template

My code follows the code style of this project. My change requires a change to the documentation.

[SPI-123] - feature/ pull requests title naming conventions

miguelemosreverte · 2022-04-25T15:16:58Z

Question @ffakenz @Ignacio-Rocca

Regarding scalafix

My experience with it was that it marked as errors unused imports and unused variables.

That is the advantage of using it.

My experience with it was that it also marked errors for files created during the akka-serverless development cycle.
(Files that are read only).

My opinion is that this experience is both not awe-inspiring regarding the pros (scalafmt = wow! scalafix = meh), and very cumbersome regarding the cons (basically its not compatible with akka-serverless)

So I put the opinion on the table and let you guys provide your opinions as well.

testagrossa

we need to add following plugins:

// Versioning
addSbtPlugin("com.eed3si9n" % "sbt-buildinfo" % "0.9.0")
addSbtPlugin("com.dwijnand" % "sbt-dynver"    % "4.1.1")

// Packing and Publishing
addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % "1.8.1")
addSbtPlugin("com.mintbeans"    % "sbt-ecr"             % "0.16.0")

// Linting & Styling
addSbtPlugin("io.github.davidgregory084" % "sbt-tpolecat" % "0.1.20")
addSbtPlugin("org.scalameta"             % "sbt-scalafmt" % "2.4.3")
addSbtPlugin("ch.epfl.scala"             % "sbt-scalafix" % "0.9.34")

addDependencyTreePlugin

.githooks/pre-commit

.github/pull_request_template.md

.github/workflows/ci.yml

.scalafmt

testagrossa

we miss .scalafix.conf file

# https://scalacenter.github.io/scalafix/docs/rules/overview.html
rules = [
  DisableSyntax
]

DisableSyntax.noThrows = true

project/Dependencies.scala

testagrossa

add .sbtops file

-J-Xms1G
-J-Xmx8G
-J-Xss1024M
-J-XX:MaxMetaspaceSize=2048M

miguelemosreverte · 2022-04-25T15:25:28Z

@testagrossa did you read the comment regarding scalafix?

testagrossa · 2022-04-25T15:27:49Z

@testagrossa did you read the comment regarding scalafix?

yes > akka-serverless projects will have to remove .scalafix if causes inconveniences, but it should be part of our template

rockit-it · 2022-04-25T15:29:00Z

@testagrossa did you read the comment regarding scalafix?

yes > akka-serverless projects will have to remove .scalafix if causes inconveniences, but it should be part of our template

same opinion here @miguelemosreverte

miguelemosreverte · 2022-04-25T15:32:35Z

@testagrossa @Ignacio-Rocca Roger Roger! scala-fix added then!

… pipeline

[SPA-123] - feature/improving project template

miguelemosreverte · 2022-04-25T15:55:28Z

@testagrossa @Ignacio-Rocca

ready!
approve?

testagrossa · 2022-04-25T16:05:39Z

build.sbt

+  .settings(
+    name := "template",
+    libraryDependencies += Testing.scalaTest
+  )


we miss to add the following settings to the project:

lazy val scalafixSettings: Seq[Setting[_]] = Seq( addCompilerPlugin(scalafixSemanticdb), semanticdbEnabled := true, scalafixOnCompile := true )

and then do

.enablePlugins(DockerPlugin, AshScriptPlugin) .settings(scalafixSettings)

and would be also nice to add

run / fork := true Test / fork := true

to the build.sbt

also would be nice to add the docker publish as part of the GHA

testagrossa

app packaging is missing

testagrossa

we also need to add the followings below scalaVersion and organization on build.sbt

ThisBuild / versionScheme   := Some("early-semver")
ThisBuild / dynverSeparator := "-"
ThisBuild / conflictManager := ConflictManager.latestRevision
ThisBuild / javacOptions ++= Seq("-source", "11", "-target", "11")
ThisBuild / scalacOptions += "-Ymacro-annotations"

testagrossa · 2022-04-25T16:10:11Z

project/plugins.sbt

+
+// Packing and Publishing
+addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % "1.8.1")
+addSbtPlugin("com.mintbeans"    % "sbt-ecr"             % "0.16.0")


this is not needed right now (the ecr plugin)

[SIP-123] - improvement/ small refactor

miguelemosreverte · 2022-04-25T16:45:05Z

@testagrossa

In general all the feedback is welcomed, expect for the macro annotations.

I have not used them not even once in all my career. They will be not added to the project settings because they are clearly never used.

[SIP-123] - feature/defaults settings for project

Add our versioning workflows and code, remove plugins from third-parties

[SPI-123] - improvement/ add our versioning workflows and code, remove plugins from third-parties

[SPI-123] - improvement/

miguelemosreverte and others added 14 commits April 25, 2022 14:59

sbt new scala/scala-seed.g8

1d17286

.gitignore should ignore /target/ folder

bcf5567

add .scalafmt

793e757

.gitignore should ignore /target/ folder, wherever it is found. Examp…

dd32537

…le, project/target

Add CI via sbt test & github actions

1c05519

pre-commit

b645dee

Add PR template

a03795c

removed the first 2 items on the PR template checklist:

6d84d07

My code follows the code style of this project. My change requires a change to the documentation.

Merge pull request #2 from Prom3th3us/feature/pull_request_templates

e4628f1

Add PR template

Update .gitignore

ed6156b

Add PR template

bf9a451

removed the first 2 items on the PR template checklist:

c0cfab8

My code follows the code style of this project. My change requires a change to the documentation.

Enforcing rules to pull request title

55b240d

Merge pull request #1 from Prom3th3us/feature/githook

6618d25

[SPI-123] - feature/ pull requests title naming conventions

miguelemosreverte requested review from ffakenz and rockit-it April 25, 2022 15:08

miguelemosreverte changed the title ~~[PER-123] improvement/ project template proposal~~ [PER-123] - improvement/ project template proposal Apr 25, 2022

testagrossa suggested changes Apr 25, 2022

View reviewed changes

.githooks/pre-commit Show resolved Hide resolved

.github/pull_request_template.md Show resolved Hide resolved

.github/workflows/ci.yml Outdated Show resolved Hide resolved

.scalafmt Outdated Show resolved Hide resolved

testagrossa suggested changes Apr 25, 2022

View reviewed changes

project/Dependencies.scala Show resolved Hide resolved

testagrossa suggested changes Apr 25, 2022

View reviewed changes

miguelemosreverte and others added 5 commits April 25, 2022 17:51

improve .sbtops

9608838

Added .scalafix and integrated it, alongside with scalafmt, to the CI…

63b5eb4

… pipeline

Fix scalafmt.conf

86dd8e3

Improve dependencies organization

847a073

Merge pull request #4 from Prom3th3us/feature/project_template

7aa5156

[SPA-123] - feature/improving project template

rockit-it approved these changes Apr 25, 2022

View reviewed changes

testagrossa suggested changes Apr 25, 2022

View reviewed changes

miguelemosreverte and others added 2 commits April 25, 2022 18:36

small pr refactor, no new features

93a1c5b

Merge pull request #5 from Prom3th3us/feature/project_template

752e7d2

[SIP-123] - improvement/ small refactor

miguelemosreverte and others added 8 commits April 25, 2022 18:47

continue to add more feedback

dd5b05e

Merge pull request #6 from Prom3th3us/feature/project_template

d308c25

[SIP-123] - feature/defaults settings for project

Add our versioning workflows and code, remove plugins from third-parties

f553962

Merge pull request #7 from Prom3th3us/feature/project_template

f87751b

Add our versioning workflows and code, remove plugins from third-parties

Add our versioning workflows and code, remove plugins from third-parties

208bbc8

Merge pull request #8 from Prom3th3us/feature/project_template

8291398

[SPI-123] - improvement/ add our versioning workflows and code, remove plugins from third-parties

Add our versioning workflows and code, remove plugins from third-parties

612cbe9

Merge pull request #9 from Prom3th3us/feature/project_template

75e3cb3

[SPI-123] - improvement/

[PER-123] - improvement/ project template proposal #3

Are you sure you want to change the base?

[PER-123] - improvement/ project template proposal #3

Uh oh!

Conversation

miguelemosreverte commented Apr 25, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Ticket

Description

Types of changes

Checklist:

Uh oh!

miguelemosreverte commented Apr 25, 2022

Uh oh!

testagrossa left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

testagrossa left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

testagrossa left a comment

Choose a reason for hiding this comment

Uh oh!

miguelemosreverte commented Apr 25, 2022

Uh oh!

testagrossa commented Apr 25, 2022

Uh oh!

rockit-it commented Apr 25, 2022

Uh oh!

miguelemosreverte commented Apr 25, 2022

Uh oh!

miguelemosreverte commented Apr 25, 2022

Uh oh!

testagrossa Apr 25, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

testagrossa Apr 25, 2022

Choose a reason for hiding this comment

Uh oh!

testagrossa left a comment

Choose a reason for hiding this comment

Uh oh!

testagrossa left a comment

Choose a reason for hiding this comment

Uh oh!

testagrossa Apr 25, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

miguelemosreverte commented Apr 25, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

miguelemosreverte commented Apr 25, 2022 •

edited

Loading

testagrossa Apr 25, 2022 •

edited

Loading

testagrossa Apr 25, 2022 •

edited

Loading