Skip to content

Commit 8f0d596

Browse files
committed
Split readme in parts.
1 parent 60b385e commit 8f0d596

File tree

3 files changed

+78
-67
lines changed

3 files changed

+78
-67
lines changed

CHANGELOG.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Changelog
2+
3+
## 2.2.0
4+
5+
- #31: Improved error messages for Coveralls API failures
6+
- #30: Improved error message for missing charset
7+
- #28: More lenient XML parsing
8+
- #26, #29: Support for Saga coverage tool and chain multiple coverage reports
9+
10+
11+
## 2.1.0
12+
13+
- #24: Filter out remote names from git branches
14+
- #19, #20: Skip configuration property to allow skipping of plugin execution
15+
16+
17+
## 2.0.1
18+
19+
- #18: Update to HttpComponents HttpClient 4.3
20+
- #15, #16, #17: Disable PKCS cryptography provider at runtime to work around OpenJDK SSL issue
21+
22+
23+
## 2.0.0
24+
25+
- #13: Dry run property for test builds
26+
- #12: Use ServiceSetup as secondary configuration source and Maven/VM properties as primary
27+
- #11: Support multiple source directories
28+
- #9: Support for other CI tools and platforms
29+
- #8: Aggregated reports for multi-module projects
30+
31+
32+
## 1.2.0
33+
34+
- #10: Validation of the Coveralls job
35+
- #4: Report build timestamp to Coveralls
36+
- #3: Log code lines from generated report to Maven console
37+
38+
39+
## 1.1.0
40+
41+
- #1: Easier configuration for Travis CI
42+
43+
44+
## 1.0.0
45+
46+
- Initial release

MIGRATION.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Migration guide
2+
3+
Changes marked with bold affect the plugin usage. Other changes are only related to development
4+
and codebase.
5+
6+
7+
## 2.x to 3.x
8+
9+
-
10+
11+
12+
## 1.x to 2.x
13+
14+
- **`sourceDirectory` parameter removed and replaced with a list parameter `sourceDirectories`**
15+
- **service environment parameters do not override configuration parameters**
16+
- `org.eluder.coveralls.maven.plugin.service.ServiceSetup` interface completely changed to reflect
17+
the service specific configuration properly
18+
- `org.eluder.coveralls.maven.plugin.service.Travis` changed to reflect the new service setup
19+
interface
20+
- `org.eluder.coveralls.maven.plugin.domain.JobValidator` and all validation related code is
21+
now located in `org.eluder.coveralls.maven.plugin.validation` package
22+
- `org.eluder.coveralls.maven.plugin.domain.GitRepository` does not take custom branch parameter
23+
as constructor argument anymore, the same behavior is handled with the new service environment
24+
setup
25+
- `org.eluder.coveralls.maven.plugin.domain.Job` has only default constructor and initialization
26+
is done with _with*_ methods, _validate()_ method returns list of validation errors instead of
27+
throwing exception
28+
- `org.eluder.coveralls.maven.plugin.domain.SourceLoader` constructor takes a list of source
29+
directories instead of a single source directory

README.md

Lines changed: 3 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -293,76 +293,12 @@ service environment will not override it.
293293
294294
### Changelog
295295
296-
#### 2.2.0
296+
See [changelog](CHANGELOG.md) for more details.
297297
298-
- #31: Improved error messages for Coveralls API failures
299-
- #30: Improved error message for missing charset
300-
- #28: More lenient XML parsing
301-
- #26, #29: Support for Saga coverage tool and chain multiple coverage reports
302298
299+
### Migration
303300
304-
#### 2.1.0
305-
306-
- #24: Filter out remote names from git branches
307-
- #19, #20: Skip configuration property to allow skipping of plugin execution
308-
309-
310-
#### 2.0.1
311-
312-
- #18: Update to HttpComponents HttpClient 4.3
313-
- #15, #16, #17: Disable PKCS cryptography provider at runtime to work around OpenJDK SSL issue
314-
315-
316-
#### 2.0.0
317-
318-
- #13: Dry run property for test builds
319-
- #12: Use ServiceSetup as secondary configuration source and Maven/VM properties as primary
320-
- #11: Support multiple source directories
321-
- #9: Support for other CI tools and platforms
322-
- #8: Aggregated reports for multi-module projects
323-
324-
325-
#### 1.2.0
326-
327-
- #10: Validation of the Coveralls job
328-
- #4: Report build timestamp to Coveralls
329-
- #3: Log code lines from generated report to Maven console
330-
331-
332-
#### 1.1.0
333-
334-
- #1: Easier configuration for Travis CI
335-
336-
337-
#### 1.0.0
338-
339-
- Initial release
340-
341-
342-
### Migration guide
343-
344-
Changes marked with bold affect the plugin usage. Other changes are only related to development
345-
and codebase.
346-
347-
348-
#### 1.x to 2.x
349-
350-
- **`sourceDirectory` parameter removed and replaced with a list parameter `sourceDirectories`**
351-
- **service environment parameters do not override configuration parameters**
352-
- `org.eluder.coveralls.maven.plugin.service.ServiceSetup` interface completely changed to reflect
353-
the service specific configuration properly
354-
- `org.eluder.coveralls.maven.plugin.service.Travis` changed to reflect the new service setup
355-
interface
356-
- `org.eluder.coveralls.maven.plugin.domain.JobValidator` and all validation related code is
357-
now located in `org.eluder.coveralls.maven.plugin.validation` package
358-
- `org.eluder.coveralls.maven.plugin.domain.GitRepository` does not take custom branch parameter
359-
as constructor argument anymore, the same behavior is handled with the new service environment
360-
setup
361-
- `org.eluder.coveralls.maven.plugin.domain.Job` has only default constructor and initialization
362-
is done with _with*_ methods, _validate()_ method returns list of validation errors instead of
363-
throwing exception
364-
- `org.eluder.coveralls.maven.plugin.domain.SourceLoader` constructor takes a list of source
365-
directories instead of a single source directory
301+
See [migration](MIGRATION.md) documentation for more information.
366302
367303
368304
### Credits

0 commit comments

Comments
 (0)