diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..d4d6e293 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,21 @@ +# Contributing + +## Making a release + +scalac-scoverage-plugin relies on +[sbt-ci-release](https://github.com/olafurpg/sbt-ci-release) for an automated +release process. In order to make this clear for anyone in the future that may +need to cut a release, I've outlined the steps below: + +1. Tag a new release locally. `git tag -a vX.X.X -m "v.X.X.X"` +2. Push the new tag upstream. `git push upstream --tags` The tag will trigger a + release via GitHub Actions. You can see this if you look in + `.github/workflows/release.yml`. +3. Once the CI has ran, everything should be available pretty much right away. + You can verify this with the script in `bin/test-release.sh`. Keep in mind + that if you add support for a new Scala version, add it to the + `test-release.sh` script. +4. Once the release is verified, update the draft release in + [here](https://github.com/scoverage/scalac-scoverage-plugin/releases) and + "publish" the release. This will notify everyone that follows the repo that a + release was made and also serve as the release notes. diff --git a/README.md b/README.md index f65d2f86..5ed2e130 100644 --- a/README.md +++ b/README.md @@ -20,139 +20,6 @@ you covered and non-covered statements, along with an upload to coveralls. ![Screenshot of scoverage report html](misc/screenshot2.png) -### Release History - -##### 1st May 2021 - 1.4.4 - -* Add support for legacy Scala versions 2.12.9 and 2.12.8 - -##### 28th April 2021 - 1.4.3 - -* Added Scala 2.12.13+, 2.13.5+ support -* All versions are now cross built with the full Scala version (instead of binary only) - -##### 12th June 2019 - 1.4.0 - -* Added Scala 2.13 support - -##### 6th November 2016 - 1.3.0 - -* Added Scala 2.12 support -* Added `excludedSymbols` option - -##### 25th September 2016 - 1.2.0 - -* Added ScalaJS support -* Added `extraBeforePhase` and `extraAfterPhase` options -* Bug fixes - -##### 22nd July 2015 - 1.1.1 - -* Bug fixes - -##### 26th April 2015 - 1.1.0 - -* Bug fixes - -##### 23rd January 2015 - 1.0.4 - -* Improved results in match/cases -* Improved results in partial functions -* Fixed bug in code grid which would render whole sections green -* Improved serializer to handle large projects (no more GC errors) -* Improved handling of guards in for loops - -##### 22nd December 2014 - 1.0.2 - -* Fix issue with line spacing in Code Grid report on Windows, - -##### 28th November 2014 - 1.0.1 - -* Fixed issue with coverageAggregate -* Fixed issue with multi project builds referencing parent code - -##### 20th November 2014 - 1.0.0 - -* Long awaited multi project support (aggregation) -* Bug fixes for classes with a directory structure different to package name -* Fixed coverage on `new` keyword -* Removed deps on commons-io -* Fixes for empty package names () -* Fixed location issue in anon classes -* Enhanced support for constructors -* Changed code grid to use pre instead of table -* Fixed errors with Javascript in Play projects. -* Re-wrote the SBT plugin completely, no longer uses custom config - -##### 3rd November 2014 - 0.99.10 - -* Fixed command line options due to changes in Scala 2.11.3+ - -##### 10th September 2014 - 0.99.9 - -* Added exclude by filename - -##### 20th July 2014 - 0.99.7 -* Fixes for final val constants -* Fixed cobertura output for ratio values - -##### 21st May 2014 - 0.99.5 - -* Major performance enhancements -* Avoids issue with timeouts on tests - -##### 19th May 2014 - 0.99.3 - -* Fixed issue with min coverage -* Added highlighting option to avoid issues with overlapping trees - -##### 15th May 2014 - 0.99.2 -* 2.11 support -* [2.10 support dropped](2.10.md) -* Fixes for macro expansion -* Fixes for @unchecked -* Fixes for for-comprehensions -* Min coverage setting -* Performance enhancements (thanks to Richard Bradley) - -##### 18th April 2014 - 0.98.2 -* Macros are now skipped instead of crashing -* Final vals are corrected measured -* Fixed parallel tests -* Test runner added for compiler -* Pre-compile phase added to run after typer and before namer -* Default parameters are now handled -* Improved handling of multiple measurement data - -##### 1st April 2014 - 0.98.0 -* Moved to org.scoverage groupId -* Measurement files now thread safe -* Add statement ID to report, to aid debugging (Richard Bradley) -* Add support for coverage exclusion comments (Richard Bradley) - -##### 8th March 2014 - 0.95.9 -* SBT plugin import issue fixed -* Fixed windows line ending issues -* Use relative href for source view -* Add support for exclude by file name - -##### 12th January 2014 - 0.95.7 -* Fixed bug with return value in pattern match -* Improved support for classname excludes -* Fixed spurious trailing green line breaks - -##### 5th January 2014 - 0.95.3 -* Fixed support for for comprehensions. -* Optimzed support for nested method calls. -* Fixed exclude package bug -* Now supports nested packages - -##### 9th December 2013 - 0.95.0 -* First stable release. -* Statement level coverage. -* Branch coverage for if, pattern match, partial function. -* HTML Generator. -* Cobertura report generator. ### Statement Coverage @@ -239,21 +106,7 @@ Any code between two such comments will not be instrumented or included in the c Further details are given in the plugin readme's. -## License -``` -This software is licensed under the Apache 2 license, quoted below. - -Copyright 2013-2015 Stephen Samuel - -Licensed under the Apache License, Version 2.0 (the "License"); you may not -use this file except in compliance with the License. You may obtain a copy of -the License at - - http://www.apache.org/licenses/LICENSE-2.0 +### Release History -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -License for the specific language governing permissions and limitations under -the License. -``` +For a full release history please see the [releases +page](https://github.com/scoverage/scalac-scoverage-plugin/releases). diff --git a/build.sbt b/build.sbt index dd53463a..0a639ebb 100644 --- a/build.sbt +++ b/build.sbt @@ -1,9 +1,6 @@ import sbtcrossproject.CrossProject import sbtcrossproject.CrossType -def localSnapshotVersion = "1.4.6-SNAPSHOT" -def isCI = System.getenv("CI") != null - val scalatestVersion = "3.2.8" val bin212 = Seq("2.12.13", "2.12.12", "2.12.11", "2.12.10", "2.12.9", "2.12.8") @@ -30,10 +27,6 @@ inThisBuild( licenses := Seq( "Apache-2.0" -> url("http://www.apache.org/license/LICENSE-2.0") ), - version ~= { dynVer => - if (isCI) dynVer - else localSnapshotVersion // only for local publishing - }, scalaVersion := bin213.head, crossScalaVersions := bin212 ++ bin213, versionScheme := Some("early-semver"),