Clean up changelog and readme, and remove external build dependencies (#38)

* [changelog] convert to org-mode format

* [readme] remove sonarcloud and codacy badges

* [jenkins] don't build with jdk 9 or 10

* [jenkins] add build with jdk 12

* [jenkins] remove codacy submission

* [jenkins] remove sonarcloud submission
This commit is contained in:
Paul Campbell 2018-12-24 08:51:18 +00:00 committed by GitHub
parent e141e67934
commit 5fb827adf6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 85 additions and 113 deletions

View file

@ -1,66 +0,0 @@
CHANGELOG
=========
NEXT
-----
* Bump kemitix-parent to 5.2.0
* Bump assertj from 3.11.1
* Bump lombok from 1.18.2
* Add kemitix-maven-tiles 0.8.1
* [checkstyle] suppress npath complexity issues
* [coverage] lower requirements
0.7.0
------
* Rename streamAll() as stream()
* Add parentStream()
* Add isRoot()
* Rename Optional<Node<T>> getParent() as findParent()
* Rename Optional<Node<T>> getData() as findData()
* Add Node<T> getParent()
* Add<Node<T> getData
0.6.0
------
* Add streamAll() support
0.5.0
------
* Make ImmutableNodeItem extend NodeItem
* Upgrade kemitix-parent to 2.1.0
* Upgrade lombok to 1.16.10
* Upgrade assertj to 3.5.2
0.4.0
------
* Upgrade kemitix-parent to 2.0.0
* Add ImmutableTree implementation
* Switch to static factory constructors
0.3.0
------
* Return optionals rather than nulls
0.2.0
------
* Demo of full-path node name
* insertInPath() uses setData()
* Dynamic node names
* New tests following mutation testing
* Tidy the Node interface
* Named nodes
* Update code style
* Drop lombok in production (still using it in test)
0.1.0
------
* Initial Release

78
CHANGELOG.org Normal file
View file

@ -0,0 +1,78 @@
* CHANGELOG
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
** [0.7.1] - unreleased
Added
- Add kemitix-maven-tiles 0.8.1
Changed
- [checkstyle] suppress npath complexity issues
- [coverage] lower requirements
Dependencies
- Bump kemitix-parent to 5.2.0
- Bump assertj from 3.11.1
- Bump lombok from 1.18.2
* [0.7.0] - 2017-02-18
- Rename streamAll() as stream()
- Add parentStream()
- Add isRoot()
- Rename Optional<Node<T>> getParent() as findParent()
- Rename Optional<Node<T>> getData() as findData()
- Add Node<T> getParent()
- Add<Node<T> getData
* [0.6.0] - 2017-02-16
- Add streamAll() support
* [0.5.0] - 2016-09-20
- Make ImmutableNodeItem extend NodeItem
- Upgrade kemitix-parent to 2.1.0
- Upgrade lombok to 1.16.10
- Upgrade assertj to 3.5.2
* [0.4.2] - 2016-09-13
- Set version in pom correctly
* [0.4.1] - 2016-09-13
- Fix broken javadoc
* [0.4.0] - 2016-09-13
- Upgrade kemitix-parent to 2.0.0
- Add ImmutableTree implementation
- Switch to static factory constructors
* [0.3.0] - 2016-05-26
- Return optionals rather than nulls
* [0.2.0] - 2016-05-25
- Demo of full-path node name
- insertInPath() uses setData()
- Dynamic node names
- New tests following mutation testing
- Tidy the Node interface
- Named nodes
- Update code style
- Drop lombok in production (still using it in test)
* [0.1.0] - 2016-01-09
- Initial Release

View file

@ -1,6 +1,5 @@
final String publicRepo = 'https://github.com/kemitix/'
final String mvn = "mvn --batch-mode --update-snapshots --errors"
final dependenciesSupportJDK = 11
pipeline {
agent any
@ -9,12 +8,6 @@ pipeline {
steps {
withMaven(maven: 'maven', jdk: 'JDK 1.8') {
sh "${mvn} clean compile checkstyle:checkstyle pmd:pmd test"
// Code Coverage to Codacy
sh "${mvn} jacoco:report com.gavinmogan:codacy-maven-plugin:coverage " +
"-DcoverageReportFile=target/site/jacoco/jacoco.xml " +
"-DprojectToken=`$JENKINS_HOME/codacy/token` " +
"-DapiToken=`$JENKINS_HOME/codacy/apitoken` " +
"-Dcommit=`git rev-parse HEAD`"
// Code Coverage to Jenkins
jacoco exclusionPattern: '**/*{Test|IT|Main|Application|Immutable}.class'
// PMD to Jenkins
@ -34,16 +27,6 @@ pipeline {
}
}
}
stage('SonarQube (published)') {
when { expression { isPublished(publicRepo) } }
steps {
withSonarQubeEnv('sonarqube') {
withMaven(maven: 'maven', jdk: 'JDK 1.8') {
sh "${mvn} org.sonarsource.scanner.maven:sonar-maven-plugin:3.4.0.905:sonar"
}
}
}
}
stage('Deploy (published release branch)') {
when {
expression {
@ -58,30 +41,20 @@ pipeline {
}
}
}
stage('Build Java 9') {
when { expression { dependenciesSupportJDK >= 9 } }
steps {
withMaven(maven: 'maven', jdk: 'JDK 9') {
sh "${mvn} clean verify -Djava.version=9"
}
}
}
stage('Build Java 10') {
when { expression { dependenciesSupportJDK >= 10 } }
steps {
withMaven(maven: 'maven', jdk: 'JDK 10') {
sh "${mvn} clean verify -Djava.version=10"
}
}
}
stage('Build Java 11') {
when { expression { dependenciesSupportJDK >= 11 } }
steps {
withMaven(maven: 'maven', jdk: 'JDK 11') {
sh "${mvn} clean verify -Djava.version=11"
}
}
}
stage('Build Java 12') {
steps {
withMaven(maven: 'maven', jdk: 'JDK 12') {
sh "${mvn} clean verify -Djava.version=12"
}
}
}
}
}

View file

@ -3,19 +3,6 @@
[[https://oss.sonatype.org/content/repositories/releases/net/kemitix/node][file:https://img.shields.io/nexus/r/https/oss.sonatype.org/net.kemitix/node.svg?style=for-the-badge]]
[[https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22net.kemitix%22%20AND%20a%3A%22node%22][file:https://img.shields.io/maven-central/v/net.kemitix/node.svg?style=for-the-badge]]
[[https://sonarcloud.io/dashboard?id=net.kemitix%3Anode][file:https://img.shields.io/sonar/https/sonarcloud.io/net.kemitix%3Anode/coverage.svg?style=for-the-badge#.svg]]
[[https://sonarcloud.io/dashboard?id=net.kemitix%3Anode][file:https://img.shields.io/sonar/https/sonarcloud.io/net.kemitix%3Anode/tech_debt.svg?style=for-the-badge#.svg]]
[[https://sonarcloud.io/dashboard?id=net.kemitix%3Anode][file:https://sonarcloud.io/api/project_badges/measure?project=net.kemitix%3Anode&metric=sqale_rating#.svg]]
[[https://sonarcloud.io/dashboard?id=net.kemitix%3Anode][file:https://sonarcloud.io/api/project_badges/measure?project=net.kemitix%3Anode&metric=alert_status#.svg]]
[[https://sonarcloud.io/dashboard?id=net.kemitix%3Anode][file:https://sonarcloud.io/api/project_badges/measure?project=net.kemitix%3Anode&metric=reliability_rating#.svg]]
[[https://sonarcloud.io/dashboard?id=net.kemitix%3Anode][file:https://sonarcloud.io/api/project_badges/measure?project=net.kemitix%3Anode&metric=security_rating#.svg]]
[[https://sonarcloud.io/dashboard?id=net.kemitix%3Anode][file:https://sonarcloud.io/api/project_badges/measure?project=net.kemitix%3Anode&metric=sqale_index#.svg]]
[[https://sonarcloud.io/dashboard?id=net.kemitix%3Anode][file:https://sonarcloud.io/api/project_badges/measure?project=net.kemitix%3Anode&metric=vulnerabilities#.svg]]
[[https://sonarcloud.io/dashboard?id=net.kemitix%3Anode][file:https://sonarcloud.io/api/project_badges/measure?project=net.kemitix%3Anode&metric=bugs#.svg]]
[[https://sonarcloud.io/dashboard?id=net.kemitix%3Anode][file:https://sonarcloud.io/api/project_badges/measure?project=net.kemitix%3Anode&metric=code_smells#.svg]]
[[https://sonarcloud.io/dashboard?id=net.kemitix%3Anode][file:https://sonarcloud.io/api/project_badges/measure?project=net.kemitix%3Anode&metric=ncloc#.svg]]
[[https://app.codacy.com/project/kemitix/node/dashboard][file:https://img.shields.io/codacy/grade/2b67fc90d79a4402aa29f1a7fcf65d7f.svg?style=for-the-badge]]
[[http://i.jpeek.org/net.kemitix/node/index.html][file:http://i.jpeek.org/net.kemitix/node/badge.svg]]
* A parent/children data structure