Skip to content

Commit ea0b7c0

Browse files
tkyitkyi
authored
fix: Update README (#1)
* update to latest dependency versions * update maven-javadoc-plugin * update to java 10 * [maven-release-plugin] prepare release wicket-pwnedpasswords-validator-1.0.2 * [maven-release-plugin] prepare for next development iteration * use range api instead of direct hash submission * [maven-release-plugin] prepare release wicket-pwnedpasswords-validator-2.0.0 * [maven-release-plugin] prepare for next development iteration * Update README.md * fix: Update README * Update README.md
1 parent abea2e8 commit ea0b7c0

File tree

5 files changed

+205
-214
lines changed

5 files changed

+205
-214
lines changed

‎Jenkinsfile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
pipeline {
22
agent any
33
tools {
4-
jdk 'jdk8'
4+
jdk 'jdk10'
55
maven 'M3'
66
}
77

‎README.md‎

Lines changed: 9 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,13 @@
1-
# wicket-pwnedpasswords-validator
1+
# sonar-coverage-example-java
22

3-
A validator for Apache Wicket that checks if a given password has been pwned.
4-
The validator uses the free API of https://haveibeenpwned.com/ by [@troyhunt](https://github.com/troyhunt) to
5-
validate that the password has not been previously exposed in data breaches.
3+
You can set up code coverage with [SonarQube](https://www.sonarqube.org/).
64

7-
[![Build Status](https://ci.martinspielmann.de/buildStatus/icon?job=pingunaut/wicket-pwnedpasswords-validator/master)](https://ci.martinspielmann.de/job/pingunaut/job/wicket-pwnedpasswords-validator/job/master/)
8-
[![Coverage](https://img.shields.io/sonar/https/sonarcloud.io/wicket-pwnedpasswords-validator/coverage.svg)](https://sonarcloud.io/component_measures?id=wicket-pwnedpasswords-validator&metric=coverage)
9-
## Usage
5+
In this example, we set some variables in our `sonar-project.properties` file. These variables will be used by SonarQube to generate code coverage results and code analysis.
106

11-
1. Include maven dependency in your pom.xml
7+
See [Screwdriver documentation for SonarQube configuration](https://docs.screwdriver.cd/user-guide/configuration/code-coverage#sonarqube) for more details.
128

13-
```xml
14-
<dependency>
15-
<groupId>de.martinspielmann.wicket</groupId>
16-
<artifactId>wicket-pwnedpasswords-validator</artifactId>
17-
<version>1.0.0</version>
18-
</dependency>
19-
```
20-
21-
2. Add PwnedPasswordsValidator to your PasswordTextField
22-
23-
```java
24-
// just your every day registration form...
25-
Form form = new Form("form");
26-
add(form);
27-
f.add(new FeedbackPanel("feedback"));
28-
PasswordTextField password = new PasswordTextField("password", new Model<>(""));
29-
form.add(password);
30-
31-
// and here it is:
32-
password.add(new PwnedPasswordsValidator());
33-
34-
```
35-
36-
## Prerequisites
37-
38-
* Maven (or download jar from [Releases](https://github.com/pingunaut/wicket-pwnedpasswords-validator/releases))
39-
* Wicket 6, 7, 8
40-
41-
## Development
42-
43-
```
44-
git clone https://github.com/pingunaut/wicket-pwnedpasswords-validator.git
45-
cd wicket-pwnedpasswords-validator
46-
mvn test
47-
```
48-
49-
## Built With
50-
51-
* [Maven](https://maven.apache.org/) - Dependency Management
52-
* [Jenkins](https://jenkins.io/) - CI Server
53-
54-
## Contributing
55-
56-
Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.
57-
58-
## Versioning
59-
60-
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).
61-
62-
## Authors
63-
64-
* **Martin Spielmann** - *Initial work* - [pingunaut](https://github.com/pingunaut)
65-
66-
See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.
67-
68-
## License
69-
70-
This project is licensed under The Apache Software License, Version 2.0 - see the [LICENSE.md](LICENSE.md) file for details
9+
## Related links
10+
* [SonarQube properties](https://docs.sonarqube.org/display/SONAR/Analysis+Parameters)
11+
* [Javascript example](https://github.com/screwdriver-cd-test/sonar-coverage-example-javascript)
12+
* [Examples from the SonarQube website](https://github.com/SonarSource/sonar-scanning-examples)
13+
* [SonarQube docs](https://docs.sonarqube.org/display/SCAN)

‎pom.xml‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
<groupId>de.martinspielmann.wicket</groupId>
2222
<artifactId>wicket-pwnedpasswords-validator</artifactId>
2323
<packaging>jar</packaging>
24-
<version>1.0.2-SNAPSHOT</version>
24+
<version>2.0.1-SNAPSHOT</version>
2525
<name>wicket-pwnedpasswords-validator</name>
2626
<description>A validator for Apache Wicket that checks if a given password has been pwned.</description>
2727
<url>https://github.com/pingunaut/wicket-pwnedpasswords-validator</url>
@@ -33,8 +33,8 @@
3333
</license>
3434
</licenses>
3535
<properties>
36-
<wicket.version>7.10.0</wicket.version>
37-
<jetty9.version>9.2.19.v20160908</jetty9.version>
36+
<wicket.version>8.0.0</wicket.version>
37+
<jetty9.version>9.2.24.v20180105</jetty9.version>
3838
<log4j.version>2.6.2</log4j.version>
3939
<junit.version>4.12</junit.version>
4040
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
@@ -119,7 +119,7 @@
119119
<inherited>true</inherited>
120120
<groupId>org.apache.maven.plugins</groupId>
121121
<artifactId>maven-compiler-plugin</artifactId>
122-
<version>3.1</version>
122+
<version>3.7.0</version>
123123
<configuration>
124124
<source>1.7</source>
125125
<target>1.7</target>
@@ -161,7 +161,7 @@
161161
<plugin>
162162
<groupId>org.jacoco</groupId>
163163
<artifactId>jacoco-maven-plugin</artifactId>
164-
<version>0.8.0</version>
164+
<version>0.8.1</version>
165165
<executions>
166166
<execution>
167167
<id>jacoco-initialize</id>
@@ -194,7 +194,7 @@
194194
</plugin>
195195
<plugin>
196196
<artifactId>maven-surefire-plugin</artifactId>
197-
<version>2.20.1</version>
197+
<version>2.21.0</version>
198198
<configuration>
199199
<argLine>${surefireArgLine}</argLine>
200200
</configuration>
@@ -234,7 +234,7 @@
234234
<plugin>
235235
<groupId>org.apache.maven.plugins</groupId>
236236
<artifactId>maven-javadoc-plugin</artifactId>
237-
<version>2.10.4</version>
237+
<version>3.0.0</version>
238238
<executions>
239239
<execution>
240240
<id>attach-javadocs</id>

0 commit comments

Comments
 (0)