Skip to content

Commit 32a3e3b

Browse files
Bernardo-MGBernardo-MG
authored
Merge pull request #3 from Bernardo-MG/release
Release
2 parents ada3464 + b712f91 commit 32a3e3b

15 files changed

Lines changed: 245 additions & 72 deletions

File tree

‎.github/workflows/deploy_docs.yml‎

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,14 @@ jobs:
2121
shell: bash
2222
run: echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/heads/})"
2323
id: extract_branch
24-
- uses: actions/checkout@v2
25-
- name: Set up JDK 1.8
24+
- name: Check-out
25+
uses: actions/checkout@v2
26+
- name: Set up JDK
2627
uses: actions/setup-java@v1
2728
with:
2829
java-version: 1.8
2930
- name: Set up Maven settings
30-
uses: Bernardo-MG/deployment-maven-settings-action@master
31+
uses: bernardo-mg/deployment-maven-settings-action@v1.1.2
3132
with:
3233
version-type: ${{ steps.extract_branch.outputs.branch }}
3334
env:
@@ -37,5 +38,9 @@ jobs:
3738
DEPLOY_DOCS_DEVELOP_PASSWORD: ${{ secrets.DEPLOY_DOCS_DEVELOP_PASSWORD }}
3839
DEPLOY_DOCS_SITE: ${{ secrets.DEPLOY_DOCS_SITE }}
3940
DEPLOY_DOCS_DEVELOP_SITE: ${{ secrets.DEPLOY_DOCS_DEVELOP_SITE }}
40-
- name: Deploy docs
41-
run: mvn site site:deploy -B -P deployment --settings settings.xml
41+
- name: Deploy development docs
42+
if: steps.extract_branch.outputs.branch == 'develop'
43+
run: mvn verify site site:deploy -B -P deployment,deployment-development --settings settings.xml
44+
- name: Deploy release docs
45+
if: steps.extract_branch.outputs.branch == 'master'
46+
run: mvn verify site site:deploy -B -P deployment,deployment-release --settings settings.xml

‎.github/workflows/testing.yml‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,11 @@ jobs:
1111
jdk: [ 8, 11, 14 ]
1212

1313
steps:
14-
- uses: actions/checkout@v2
15-
- name: Set up JDK 1.8
14+
- name: Check-out
15+
uses: actions/checkout@v2
16+
- name: Set up JDK ${{ matrix.jdk }}
1617
uses: actions/setup-java@v1
1718
with:
1819
java-version: ${{ matrix.jdk }}
19-
- name: Runs tests
20+
- name: Run all tests
2021
run: mvn clean verify

‎pom.xml‎

Lines changed: 6 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121
<groupId>com.bernardomg.tabletop</groupId>
2222
<artifactId>dice-cli</artifactId>
23-
<version>1.1.0</version>
23+
<version>1.1.1</version>
2424
<packaging>jar</packaging>
2525

2626
<name>Dice Notation Tools CLI</name>
@@ -30,8 +30,8 @@
3030

3131
<licenses>
3232
<license>
33-
<name>MIT License</name>
34-
<url>http://www.opensource.org/licenses/mit-license.php</url>
33+
<name>Apache v2 License</name>
34+
<url>http://www.apache.org/licenses/LICENSE-2.0.html</url>
3535
<distribution>repo</distribution>
3636
</license>
3737
</licenses>
@@ -174,11 +174,11 @@
174174
<!-- ============================================== -->
175175
<!-- =========== DEPENDENCIES VERSIONS ============ -->
176176
<!-- ============================================== -->
177-
<dice.version>2.0.2</dice.version>
177+
<dice.version>2.0.4</dice.version>
178178
<guava.version>29.0-jre</guava.version>
179179
<junit.jupiter.version>5.6.2</junit.jupiter.version>
180-
<mockito.version>3.3.3</mockito.version>
181-
<picocli.version>4.4.0</picocli.version>
180+
<mockito.version>3.5.13</mockito.version>
181+
<picocli.version>4.5.1</picocli.version>
182182
<log4j.version>2.13.3</log4j.version>
183183
<slf4j.version>1.7.30</slf4j.version>
184184
<spring.boot.version>2.3.1.RELEASE</spring.boot.version>
@@ -403,31 +403,13 @@
403403
<configuration>
404404
<!-- The customized rules file -->
405405
<configLocation>${project.basedir}/src/config/checkstyle/checkstyle-rules.xml</configLocation>
406-
<!-- Excludes generated code -->
407-
<excludes>**/generated/**/*</excludes>
408406
</configuration>
409407
</plugin>
410408
<plugin>
411409
<!-- FindBugs -->
412410
<!-- Checks for patterns which are prone to errors -->
413411
<groupId>org.codehaus.mojo</groupId>
414412
<artifactId>findbugs-maven-plugin</artifactId>
415-
<configuration>
416-
<!-- Exclusion patterns -->
417-
<excludeFilterFile>${project.basedir}/src/config/findbugs/findbugs-exclude.xml</excludeFilterFile>
418-
</configuration>
419-
</plugin>
420-
<plugin>
421-
<!-- Javadoc -->
422-
<!-- Generates the javadocs -->
423-
<groupId>org.apache.maven.plugins</groupId>
424-
<artifactId>maven-javadoc-plugin</artifactId>
425-
<configuration>
426-
<sourceFileExcludes>
427-
<!-- Excludes generated code -->
428-
<exclude>**/generated/**/*</exclude>
429-
</sourceFileExcludes>
430-
</configuration>
431413
</plugin>
432414
<plugin>
433415
<!-- PMD -->
@@ -439,10 +421,6 @@
439421
<!-- The customized rules file -->
440422
<ruleset>${project.basedir}/src/config/pmd/pmd-rules.xml</ruleset>
441423
</rulesets>
442-
<excludes>
443-
<!-- Excludes generated code -->
444-
<exclude>**/generated/**/*</exclude>
445-
</excludes>
446424
</configuration>
447425
</plugin>
448426
</plugins>

‎readme.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,11 +72,11 @@ If you wish to fork or modify the code, visit the [GitHub project page][scm], wh
7272
The project has been released under the [MIT License][license].
7373

7474
[issues]: https://github.com/bernardo-mg/dice-notation-java-cli/issues
75-
[javadoc-develop]: http://docs.bernardomg.com/development/maven/dice-notation-java-cli/apidocs
76-
[javadoc-release]: http://docs.bernardomg.com/maven/dice-notation-java-cli/apidocs
75+
[javadoc-develop]: https://docs.bernardomg.com/development/maven/dice-notation-java-cli/apidocs
76+
[javadoc-release]: https://docs.bernardomg.com/maven/dice-notation-java-cli/apidocs
7777
[license]: https://www.opensource.org/licenses/mit-license.php
7878
[scm]: https://github.com/bernardo-mg/dice-notation-java-cli
79-
[site-develop]: http://docs.bernardomg.com/development/maven/dice-notation-java-cli
80-
[site-release]: http://docs.bernardomg.com/maven/dice-notation-java-cli
79+
[site-develop]: https://docs.bernardomg.com/development/maven/dice-notation-java-cli
80+
[site-release]: https://docs.bernardomg.com/maven/dice-notation-java-cli
8181

8282
[dice-notation-tools]: https://github.com/Bernardo-MG/dice-notation-java

‎src/changes/changes.xml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,10 @@
1818
Extended and improved CLI.
1919
</action>
2020
</release>
21+
<release version="1.1.1" date="2020-10-09" description="Small corrections">
22+
<action dev="bmg" type="fix">
23+
Several small corrections.
24+
</action>
25+
</release>
2126
</body>
2227
</document>

‎src/config/findbugs/findbugs-exclude.xml‎

Lines changed: 0 additions & 9 deletions
This file was deleted.

‎src/main/java/com/bernardomg/tabletop/dice/cli/Main.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
import org.slf4j.Logger;
2020
import org.slf4j.LoggerFactory;
2121

22-
import com.bernardomg.tabletop.dice.cli.command.DiceMenu;
22+
import com.bernardomg.tabletop.dice.cli.menu.DiceMenu;
2323

2424
import picocli.CommandLine;
2525

‎src/main/java/com/bernardomg/tabletop/dice/cli/command/DiceGathererCommand.java‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,13 +54,22 @@ public final class DiceGathererCommand implements Runnable {
5454
private static final Logger LOGGER = LoggerFactory
5555
.getLogger(DiceGathererCommand.class);
5656

57+
/**
58+
* Expression to roll.
59+
*/
5760
@Parameters(index = "0", description = "The expression to roll",
5861
paramLabel = "EXP")
5962
private String expression;
6063

64+
/**
65+
* Command specification. Used to get the line output.
66+
*/
6167
@Spec
6268
private CommandSpec spec;
6369

70+
/**
71+
* Default constructor.
72+
*/
6473
public DiceGathererCommand() {
6574
super();
6675
}

‎src/main/java/com/bernardomg/tabletop/dice/cli/command/DiceRollCommand.java‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,30 +55,55 @@ public final class DiceRollCommand implements Runnable {
5555
private static final Logger LOGGER = LoggerFactory
5656
.getLogger(DiceRollCommand.class);
5757

58+
/**
59+
* Expression to roll.
60+
*/
5861
@Parameters(index = "0", description = "The expression to roll",
5962
paramLabel = "EXP")
6063
private String expression;
6164

65+
/**
66+
* Roll history flag.
67+
*/
6268
@Option(names = "-history", description = "Prints the roll history",
6369
defaultValue = "false")
6470
private Boolean history;
6571

72+
/**
73+
* Full history flag.
74+
*/
6675
@Option(names = "-fullHistory",
6776
description = "Prints a detailed roll history",
6877
defaultValue = "false")
6978
private Boolean historyDetailed;
7079

80+
/**
81+
* Command specification. Used to get the line output.
82+
*/
7183
@Spec
7284
private CommandSpec spec;
7385

86+
/**
87+
* Default constructor.
88+
*/
7489
public DiceRollCommand() {
7590
super();
7691
}
7792

93+
/**
94+
* Returns the history flag.
95+
*
96+
* @return the history flag
97+
*/
7898
public Boolean getHistory() {
7999
return history;
80100
}
81101

102+
/**
103+
* Returns the detailed history flag.
104+
*
105+
* @return the detailed history flag
106+
*/
82107
public Boolean getHistoryDetailed() {
83108
return historyDetailed;
84109
}

‎src/main/java/com/bernardomg/tabletop/dice/cli/command/package-info.java‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
/**
2+
* Copyright 2020 the original author or authors
3+
* <p>
4+
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
5+
* use this file except in compliance with the License. You may obtain a copy of
6+
* the License at
7+
* <p>
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
* <p>
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12+
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13+
* License for the specific language governing permissions and limitations under
14+
* the License.
15+
*/
16+
/**
17+
* CLI commands.
18+
*/
19+
20+
package com.bernardomg.tabletop.dice.cli.command;

0 commit comments

Comments
 (0)