Skip to content

Commit b7e2232

Browse files
authored
Add in release steps. (#331)
Just to document how the release is done I've gone ahead and added a release section into a CONTRIBUTING.md file. I've also migrated the release notes in the README to the corresponding releases on GitHub to clean up the README a bit. Same with the license, since this is displayed on GitHub and also included in the repo, I just removed it from the README. NOTE the license still fully remains the same.
1 parent bf081e1 commit b7e2232

File tree

3 files changed

+24
-157
lines changed

3 files changed

+24
-157
lines changed

CONTRIBUTING.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Contributing
2+
3+
## Making a release
4+
5+
scalac-scoverage-plugin relies on
6+
[sbt-ci-release](https://github.com/olafurpg/sbt-ci-release) for an automated
7+
release process. In order to make this clear for anyone in the future that may
8+
need to cut a release, I've outlined the steps below:
9+
10+
1. Tag a new release locally. `git tag -a vX.X.X -m "v.X.X.X"`
11+
2. Push the new tag upstream. `git push upstream --tags` The tag will trigger a
12+
release via GitHub Actions. You can see this if you look in
13+
`.github/workflows/release.yml`.
14+
3. Once the CI has ran, everything should be available pretty much right away.
15+
You can verify this with the script in `bin/test-release.sh`. Keep in mind
16+
that if you add support for a new Scala version, add it to the
17+
`test-release.sh` script.
18+
4. Once the release is verified, update the draft release in
19+
[here](https://github.com/scoverage/scalac-scoverage-plugin/releases) and
20+
"publish" the release. This will notify everyone that follows the repo that a
21+
release was made and also serve as the release notes.

README.md

+3-150
Original file line numberDiff line numberDiff line change
@@ -20,139 +20,6 @@ you covered and non-covered statements, along with an upload to coveralls.
2020

2121
![Screenshot of scoverage report html](misc/screenshot2.png)
2222

23-
### Release History
24-
25-
##### 1st May 2021 - 1.4.4
26-
27-
* Add support for legacy Scala versions 2.12.9 and 2.12.8
28-
29-
##### 28th April 2021 - 1.4.3
30-
31-
* Added Scala 2.12.13+, 2.13.5+ support
32-
* All versions are now cross built with the full Scala version (instead of binary only)
33-
34-
##### 12th June 2019 - 1.4.0
35-
36-
* Added Scala 2.13 support
37-
38-
##### 6th November 2016 - 1.3.0
39-
40-
* Added Scala 2.12 support
41-
* Added `excludedSymbols` option
42-
43-
##### 25th September 2016 - 1.2.0
44-
45-
* Added ScalaJS support
46-
* Added `extraBeforePhase` and `extraAfterPhase` options
47-
* Bug fixes
48-
49-
##### 22nd July 2015 - 1.1.1
50-
51-
* Bug fixes
52-
53-
##### 26th April 2015 - 1.1.0
54-
55-
* Bug fixes
56-
57-
##### 23rd January 2015 - 1.0.4
58-
59-
* Improved results in match/cases
60-
* Improved results in partial functions
61-
* Fixed bug in code grid which would render whole sections green
62-
* Improved serializer to handle large projects (no more GC errors)
63-
* Improved handling of guards in for loops
64-
65-
##### 22nd December 2014 - 1.0.2
66-
67-
* Fix issue with line spacing in Code Grid report on Windows,
68-
69-
##### 28th November 2014 - 1.0.1
70-
71-
* Fixed issue with coverageAggregate
72-
* Fixed issue with multi project builds referencing parent code
73-
74-
##### 20th November 2014 - 1.0.0
75-
76-
* Long awaited multi project support (aggregation)
77-
* Bug fixes for classes with a directory structure different to package name
78-
* Fixed coverage on `new` keyword
79-
* Removed deps on commons-io
80-
* Fixes for empty package names (<empty>)
81-
* Fixed location issue in anon classes
82-
* Enhanced support for constructors
83-
* Changed code grid to use pre instead of table
84-
* Fixed errors with Javascript in Play projects.
85-
* Re-wrote the SBT plugin completely, no longer uses custom config
86-
87-
##### 3rd November 2014 - 0.99.10
88-
89-
* Fixed command line options due to changes in Scala 2.11.3+
90-
91-
##### 10th September 2014 - 0.99.9
92-
93-
* Added exclude by filename
94-
95-
##### 20th July 2014 - 0.99.7
96-
* Fixes for final val constants
97-
* Fixed cobertura output for ratio values
98-
99-
##### 21st May 2014 - 0.99.5
100-
101-
* Major performance enhancements
102-
* Avoids issue with timeouts on tests
103-
104-
##### 19th May 2014 - 0.99.3
105-
106-
* Fixed issue with min coverage
107-
* Added highlighting option to avoid issues with overlapping trees
108-
109-
##### 15th May 2014 - 0.99.2
110-
* 2.11 support
111-
* [2.10 support dropped](2.10.md)
112-
* Fixes for macro expansion
113-
* Fixes for @unchecked
114-
* Fixes for for-comprehensions
115-
* Min coverage setting
116-
* Performance enhancements (thanks to Richard Bradley)
117-
118-
##### 18th April 2014 - 0.98.2
119-
* Macros are now skipped instead of crashing
120-
* Final vals are corrected measured
121-
* Fixed parallel tests
122-
* Test runner added for compiler
123-
* Pre-compile phase added to run after typer and before namer
124-
* Default parameters are now handled
125-
* Improved handling of multiple measurement data
126-
127-
##### 1st April 2014 - 0.98.0
128-
* Moved to org.scoverage groupId
129-
* Measurement files now thread safe
130-
* Add statement ID to report, to aid debugging (Richard Bradley)
131-
* Add support for coverage exclusion comments (Richard Bradley)
132-
133-
##### 8th March 2014 - 0.95.9
134-
* SBT plugin import issue fixed
135-
* Fixed windows line ending issues
136-
* Use relative href for source view
137-
* Add support for exclude by file name
138-
139-
##### 12th January 2014 - 0.95.7
140-
* Fixed bug with return value in pattern match
141-
* Improved support for classname excludes
142-
* Fixed spurious trailing green line breaks
143-
144-
##### 5th January 2014 - 0.95.3
145-
* Fixed support for for comprehensions.
146-
* Optimzed support for nested method calls.
147-
* Fixed exclude package bug
148-
* Now supports nested packages
149-
150-
##### 9th December 2013 - 0.95.0
151-
* First stable release.
152-
* Statement level coverage.
153-
* Branch coverage for if, pattern match, partial function.
154-
* HTML Generator.
155-
* Cobertura report generator.
15623

15724
### Statement Coverage
15825

@@ -239,21 +106,7 @@ Any code between two such comments will not be instrumented or included in the c
239106

240107
Further details are given in the plugin readme's.
241108

242-
## License
243-
```
244-
This software is licensed under the Apache 2 license, quoted below.
245-
246-
Copyright 2013-2015 Stephen Samuel
247-
248-
Licensed under the Apache License, Version 2.0 (the "License"); you may not
249-
use this file except in compliance with the License. You may obtain a copy of
250-
the License at
251-
252-
http://www.apache.org/licenses/LICENSE-2.0
109+
### Release History
253110

254-
Unless required by applicable law or agreed to in writing, software
255-
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
256-
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
257-
License for the specific language governing permissions and limitations under
258-
the License.
259-
```
111+
For a full release history please see the [releases
112+
page](https://github.com/scoverage/scalac-scoverage-plugin/releases).

build.sbt

-7
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
import sbtcrossproject.CrossProject
22
import sbtcrossproject.CrossType
33

4-
def localSnapshotVersion = "1.4.6-SNAPSHOT"
5-
def isCI = System.getenv("CI") != null
6-
74
val scalatestVersion = "3.2.8"
85

96
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(
3027
licenses := Seq(
3128
"Apache-2.0" -> url("http://www.apache.org/license/LICENSE-2.0")
3229
),
33-
version ~= { dynVer =>
34-
if (isCI) dynVer
35-
else localSnapshotVersion // only for local publishing
36-
},
3730
scalaVersion := bin213.head,
3831
crossScalaVersions := bin212 ++ bin213,
3932
versionScheme := Some("early-semver"),

0 commit comments

Comments
 (0)