Merge pull request #19 from counter2015/github-actions

Update things to latest.

Author: thomasrockhu-codecov

.github/workflows/test.yaml

@@ -0,0 +1,20 @@
+name: Test workflow
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Test scala
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-java@v4
+        with:
+          distribution: 'adopt'
+          java-version: '21'
+      - name: Run tests
+        run: sbt coverage test coverageReport
+      - uses: codecov/codecov-action@v4
+        with:
+          fail_ci_if_error: true
+          token: ${{ secrets.CODECOV_TOKEN }}

.travis.yml

@@ -4,25 +4,55 @@
 
 ## Guide
 
-### Travis Setup
+### GitHub Actions Setup
+You should first get the repository upload token from [codecov](https://docs.codecov.com/docs/quick-start#step-2-get-the-repository-upload-token)
 
-Add to your `.travis.yml` file.
+Add the following to your `.github/workflows/test.yml` file. 
 ```yml
-language: scala
-after_success:
-  - bash <(curl -s https://codecov.io/bash)
+name: Test workflow
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Test scala
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-java@v4
+        with:
+          distribution: 'adopt'
+          java-version: '21'
+      - name: Run tests
+        run: sbt coverage test coverageReport
+      - uses: codecov/codecov-action@v4
+        with:
+          fail_ci_if_error: true
+          token: ${{ secrets.CODECOV_TOKEN }}
+```
+
+Here we frist checkout the code, then setup java, run the tests and generate the coverage report. Finally, we upload the report to codecov using the codecov-action.
+
+When all finished, you could also add a badge on readme like following.
+
+```
+[![codecov](https://codecov.io/gh/YOUR_ACCOUNT/YOUR_REPO/branch/YOUR_BRANCH/graph/badge.svg)](https://codecov.io/gh/YOUR_ACCOUNT/YOUR_REPO)
 ```
 
 ### Produce Coverage Reports
 
 1. Add `scoverage` to plugin list
-  - `addSbtPlugin("org.scoverage" % "sbt-scoverage" % "1.5.1")` as [seen here](https://github.com/codecov/example-scala/blob/master/project/plugins.sbt#L1)
+  - `addSbtPlugin("org.scoverage" % "sbt-scoverage" % "2.0.11")` as [seen here](https://github.com/codecov/example-scala/blob/master/project/plugins.sbt#L1)
 1. Add `coverage` and `coverageReport` to `sbt`
   - `sbt clean coverage test coverageReport` as [seen here](https://github.com/codecov/example-scala/blob/master/.travis.yml#L7)
 
 ## Caveats
 ### Private Repo
-Repository tokens are required for (a) all private repos, (b) public repos not using Travis-CI, CircleCI or AppVeyor. Find your repository token at Codecov and provide via appending `-t <your upload token>` to you where you upload reports.
+Repository tokens are required for 
+- (a) all private repos, 
+- (b) public repos not using Travis-CI, CircleCI or AppVeyor. 
+
+Find your repository token at Codecov and provide via appending `-t <your upload token>` to you where you upload reports.
 
 ## Links
 - [Community Boards](https://community.codecov.io)

README.md

@@ -1,12 +1,13 @@
-name := "scala"
+ThisBuild / version := "0.1.0-SNAPSHOT"
 
-version := "0.98.5"
+ThisBuild / scalaVersion := "2.13.13"
 
-scalaVersion := "2.10.2"
+lazy val root = (project in file("."))
+  .settings(
+    name := "example-scala",
+  )
 
-crossScalaVersions := Seq("2.10.2", "2.10.3", "2.11.8")
 
 libraryDependencies ++= Seq(
-  "junit"          % "junit"           % "4.5",
-  "org.scalatest"  %% "scalatest"      % "3.0.1"
+  "org.scalatest" %% "scalatest" % "3.2.18" % Test
 )

build.sbt

@@ -1 +1 @@
-sbt.version=0.13.13
+sbt.version=1.9.9

project/build.properties

@@ -1 +1 @@
-addSbtPlugin("org.scoverage" % "sbt-scoverage" % "1.5.1")
+addSbtPlugin("org.scoverage" % "sbt-scoverage" % "2.0.11")

project/plugins.sbt

@@ -1,20 +1,15 @@
 package com.awesomeness
 
-class Awesomeness {
-  def main(args: Array[String]) {
+object Awesome {
+  def main(args: Array[String]): Unit = {
     println("Hello, world! " + args.toList)
   }
-  def square(x:Int): Int= {
-    x*x
-  }
-  def multiple(x:Int,y:Int): Int= {
-    x*y
-  }
-}
 
+  def square(x: Int): Int = {
+    x * x
+  }
 
-object HelloWorld {
-  def main(args: Array[String]) {
-    println("Hello, world! " + args.toList)
+  def multiple(x: Int, y: Int): Int = {
+    x * y
   }
 }

src/main/scala/com/awesomeness/Awesome.scala

@@ -1,14 +1,13 @@
 package com.awesomeness
 
-import org.scalatest.junit.JUnitSuite
-import junit.framework.Assert._
-import org.junit.Test
+import org.scalatest.flatspec.AnyFlatSpec
+import org.scalatest.matchers.should
 
-class TestAwesome extends JUnitSuite {
- val awesome = new Awesomeness
+class TestAwesome extends AnyFlatSpec with should.Matchers {
 
- @ Test def awesomeExample {
-    assertEquals(1, awesome square 1)
-    assertEquals(6, awesome multiple (2,3))
+  "Awesome" should "work" in {
+    assert(Awesome.square(1) == 1)
+    assert(Awesome.multiple(2,3) == 6)
   }
+
 }