Merge pull request #41 from codacy/luis-ferreira/patch/rework-circle-ci

Rework Circle CI configuration to tag the version automatically and use orbs

Author: ljmf00

.circleci/config.yml

@@ -1,163 +1,57 @@
-# CircleCI 2.0 configuration file
-version: 2
+version: 2.1
 
-# Re-usable blocks to reduce boilerplate in job definitions.
-references:
-  host_environment_defaults: &host_environment_defaults
-    # Customize the JVM maximum heap limit
-    JAVA_OPTS: -Xmx3200m
-  docker_environment_defaults: &docker_environment_defaults
-    # Customize the JVM to read correct memory values
-    JAVA_OPTS: '-XX:+UnlockExperimentalVMOptions -XX:+UseCGroupMemoryLimitForHeap -XX:MaxRAMFraction=1'
-
-  default_java_job: &default_java_job
-    docker:
-      - image: circleci/openjdk:8-jdk
-        environment:
-          <<: *docker_environment_defaults
-    environment:
-      <<: *host_environment_defaults
-    working_directory: ~/workdir
-
-  restore_source_code: &restore_source_code
-    restore_cache:
-      keys:
-        - source-code-1.0.0-{{ .Branch }}-{{ .Revision }}
-        - source-code-1.0.0-{{ .Branch }}
-        - source-code-1.0.0
-  restore_dependencies: &restore_dependencies
-    restore_cache:
-      keys:
-        - sbt-ivy2-dependencies-1.0.0-{{ checksum "/tmp/dependencies.cache.tmp" }}
-        - sbt-ivy2-dependencies-1.0.0
-  restore_build: &restore_build
-    restore_cache:
-      keys:
-        - sbt-build-1.0.1-{{ .Branch }}-{{ .Revision }}
-        - sbt-build-1.0.1
-
-  setup_dependencies_key: &setup_dependencies_key
-    run:
-      name: Generate cache key
-      command: |
-        shasum build.sbt \
-          project/plugins.sbt \
-          project/build.properties > /tmp/dependencies.cache.tmp
-
-jobs:
-  checkout_code:
-    <<: *default_java_job
-    steps:
-      - *restore_source_code
-      - checkout
-      - save_cache:
-          key: source-code-1.0.0-{{ .Branch }}-{{ .Revision }}
-          paths:
-            - ~/workdir
-
-  sbt_dependencies:
-    <<: *default_java_job
-    steps:
-      - *restore_source_code
-      - *setup_dependencies_key
-      - *restore_dependencies
-      - run:
-          name: Resolve dependencies
-          command: |
-            sbt update
-      - save_cache:
-          paths:
-            - ~/.ivy2
-            - ~/.sbt
-            - ~/.coursier/cache/v1
-          key: sbt-ivy2-dependencies-1.0.0-{{ checksum "/tmp/dependencies.cache.tmp" }}
-
-  compile:
-    <<: *default_java_job
-    steps:
-      - *restore_source_code
-      - *setup_dependencies_key
-      - *restore_dependencies
-      - *restore_build
-      - run:
-          name: Compile
-          command: ./scripts/compile.sh
-      - save_cache:
-          paths:
-            - ~/workdir/target
-            - ~/workdir/project/target
-          key: sbt-build-1.0.0-{{ .Branch }}-{{ .Revision }}
-
-  test:
-    <<: *default_java_job
-    steps:
-      - *restore_source_code
-      - *setup_dependencies_key
-      - *restore_dependencies
-      - *restore_build
-      - run:
-          name: Test
-          command: ./scripts/test.sh
-      - run:
-          name: Store test reports
-          working_directory: ~/
-          command: |
-            mkdir -p ~/coverage-reports/scoverage
-            cp -f ~/workdir/target/scala-2.12/coverage-report/cobertura.xml ~/coverage-reports/scoverage/results.xml
-      - store_test_results:
-          path: ~/coverage-reports
-      - store_artifacts:
-          path: ~/workdir/target/scala-2.12/coverage-report
-      - store_artifacts:
-          path: ~/workdir/target/scala-2.12/scoverage-report
-      - store_artifacts:
-          path: ~/workdir/target/scala-2.12/scoverage-data
-
-  publish:
-    <<: *default_java_job
-    steps:
-      - *restore_source_code
-      - *setup_dependencies_key
-      - *restore_dependencies
-      - *restore_build
-      - run:
-          name: Install AWS CLI
-          command: |
-            sudo apt -y update
-            sudo apt -y install python3-pip
-            sudo python3 -m pip install awscli
-      - run:
-          name: Setup AWS Credentials
-          command: ./scripts/setup-aws-credentials.sh
-      - run:
-          name: Retrieve GPG Keys
-          command: |
-            mkdir -p ~/.gnupg
-            aws s3 sync --profile shared-services --include '*.gpg' s3://$AWS_CREDENTIALS_BUCKET/gnupg/ ~/.gnupg
-      - run:
-          name: Publish to Sonatype
-          command: ./scripts/publish.sh 3.0.$CIRCLE_BUILD_NUM
+orbs:
+  codacy: codacy/[email protected]
 
 workflows:
   version: 2
-  test-and-publish:
+  compile_test_deploy:
     jobs:
-      - checkout_code
-      - sbt_dependencies:
+      - codacy/checkout_and_version:
+          write_sbt_version: true
+      - codacy/sbt:
+          name: populate_cache
+          cmd: sbt "set scalafmtUseIvy in ThisBuild := false;update"
+          persist_to_workspace: true
           requires:
-            - checkout_code
-      - compile:
+            - codacy/checkout_and_version
+      - codacy/sbt:
+          name: check_fmt
+          cmd: sbt "scalafmt::test;test:scalafmt::test;sbt:scalafmt::test"
           requires:
-            - checkout_code
-            - sbt_dependencies
-      - test:
+            - populate_cache
+      - codacy/sbt:
+          name: compile
+          cmd: |
+            sbt +compile
+            sbt +test:compile
+          requires:
+            - check_fmt
+      - codacy/sbt:
+          name: test
+          cmd: |
+            sbt "coverage;coverageReport;coverageAggregate"
+            sbt +test
+
+            if [ -z "$CODACY_PROJECT_TOKEN" ]; then
+                echo "CODACY_PROJECT_TOKEN not found. Skipping send coverage to Codacy."
+            else
+                sbt codacyCoverage
+            fi
           requires:
             - compile
-      - publish:
+      - codacy/sbt:
+          name: publish
+          cmd: |
+            sbt "clean;retrieveGPGKeys"
+            sbt "+publishSigned;sonatypeRelease"
           context: CodacyAWS
           requires:
             - test
           filters:
             branches:
               only:
                 - master
+      - codacy/tag_version:
+          requires:
+            - publish

build.sbt

@@ -1,16 +1,15 @@
 val scala211 = "2.11.12"
 val scala212 = "2.12.8"
-val scala213 = "2.13.0"
+val scala213 = "2.13.1"
 
 name := "codacy-plugins-api"
 organization := "com.codacy"
 
 scalaVersion := scala212
+
 crossScalaVersions := Seq(scala211, scala212, scala213)
 
-libraryDependencies ++= Seq(
-  "org.specs2" %% "specs2-core" % "4.6.0" % Test
-)
+libraryDependencies ++= Seq("org.specs2" %% "specs2-core" % "4.7.1" % Test)
 
 unmanagedSourceDirectories in Compile += {
   val sourceDir = (sourceDirectory in Compile).value
@@ -20,68 +19,11 @@ unmanagedSourceDirectories in Compile += {
   }
 }
 
-// Sonatype repository settings
-ThisBuild / credentials += Credentials(
-  "Sonatype Nexus Repository Manager",
-  "oss.sonatype.org",
-  sys.env.getOrElse("SONATYPE_USER", "username"),
-  sys.env.getOrElse("SONATYPE_PASSWORD", "password")
-)
-ThisBuild / organization := "com.codacy"
-ThisBuild / organizationName := "Codacy"
-ThisBuild / organizationHomepage := Some(url("https://www.codacy.com"))
+pgpPassphrase := Option(System.getenv("SONATYPE_GPG_PASSPHRASE")).map(_.toCharArray)
 
-ThisBuild / scmInfo := Some(
-  ScmInfo(
-    url("https://github.com/codacy/codacy-plugins-api"),
-    "scm:[email protected]:codacy/codacy-plugins-api"
-  )
-)
-ThisBuild / developers := List(
-  Developer(
-    id = "johannegger",
-    name = "Johann",
-    email = "johann [at] codacy.com",
-    url = url("https://github.com/johannegger")
-  ),
-  Developer(
-    id = "rtfpessoa",
-    name = "Rodrigo Fernandes",
-    email = "rodrigo [at] codacy.com",
-    url = url("https://github.com/rtfpessoa")
-  ),
-  Developer(
-    id = "bmbferreira",
-    name = "Bruno Ferreira",
-    email = "bruno.ferreira [at] codacy.com",
-    url = url("https://github.com/bmbferreira")
-  ),
-  Developer(id = "xplosunn",
-            name = "Hugo Sousa",
-            email = "hugo [at] codacy.com",
-            url = url("https://github.com/xplosunn")),
-  Developer(
-    id = "pedrocodacy",
-    name = "Pedro Amaral",
-    email = "pamaral [at] codacy.com",
-    url = url("https://github.com/pedrocodacy")
-  )
-)
+description := "A dependency free api for Codacy Tools"
 
-ThisBuild / startYear := Some(2016)
-ThisBuild / description := "Library to develop Codacy tool plugins"
-ThisBuild / licenses := List(
-  "The Apache Software License, Version 2.0" -> url("http://www.apache.org/licenses/LICENSE-2.0.txt"))
-ThisBuild / homepage := Some(url("http://www.github.com/codacy/codacy-plugins-api/"))
+scmInfo := Some(
+  ScmInfo(url("https://github.com/codacy/codacy-plugins-api"), "scm:git:[email protected]:codacy/codacy-plugins-api.git"))
 
-// Remove all additional repository other than Maven Central from POM
-ThisBuild / pomIncludeRepository := { _ =>
-  false
-}
-ThisBuild / publishTo := {
-  val nexus = "https://oss.sonatype.org/"
-  if (isSnapshot.value) Some("snapshots" at nexus + "content/repositories/snapshots")
-  else Some("releases" at nexus + "service/local/staging/deploy/maven2")
-}
-ThisBuild / publishMavenStyle := true
-ThisBuild / publishArtifact in Test := false
+publicMvnPublish

project/build.properties

@@ -1 +1 @@
-sbt.version=1.3.0
+sbt.version=1.3.2

project/plugins.sbt

@@ -1,10 +1,3 @@
-// Sonatype publishing
-addSbtPlugin("org.xerial.sbt" % "sbt-sonatype" % "2.3")
-addSbtPlugin("com.jsuereth" % "sbt-pgp" % "1.1.2-1")
+resolvers += Resolver.jcenterRepo
 
-// Dependency updates
-addSbtPlugin("com.timushev.sbt" % "sbt-updates" % "0.3.4")
-
-// Coverage
-addSbtPlugin("org.scoverage" % "sbt-scoverage" % "1.6.0")
-addSbtPlugin("com.codacy" % "sbt-codacy-coverage" % "1.3.15")
+addSbtPlugin("com.codacy" % "codacy-sbt-plugin" % "17.1.2")