Enhance documentation and build (#612)

* Add development section to docs * Update versions in build * Lock versions in GH Actions
JodaOrg · Jul 30, 2022 · 807cdd1 · 807cdd1
1 parent 9c0704e
commit 807cdd1
Show file tree

Hide file tree

Showing 4 changed files with 46 additions and 40 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -18,25 +18,23 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - name: Set up JDK
-      uses: actions/setup-java@v1
-      with:
-        java-version: 1.8
     - name: Checkout
-      uses: actions/checkout@v2
-    - name: Maven cache
-      uses: actions/cache@v1
+      uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b  #v3.0.2
+
+    - name: Set up JDK
+      uses: actions/setup-java@2c7a4878f5d120bd643426d54ae1209b29cc01a3  #v3.4.1
       with:
-        path: ~/.m2/repository
-        key: ${{ runner.os }}-maven-${{ matrix.java }}-${{ hashFiles('**/pom.xml') }}-${{ hashFiles('.github/workflows/build.yml') }}
-        restore-keys: |
-          ${{ runner.os }}-maven-
+        java-version: '8'
+        distribution: 'corretto'
+        cache: 'maven'
+
     - name: Maven version
       run: |
         mkdir -p ./.mvn
         echo '-e -B -DtrimStackTrace=false' > ./.mvn/maven.config
         mvn --version
         mkdir -p target
+
     - name: Maven build
       run: |
         mvn install site

diff --git a/.github/workflows/tzdbupdate.yml b/.github/workflows/tzdbupdate.yml
@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - 'master'
+      - 'enhance*'
   schedule:
     - cron: '50 1 * * *'
 
@@ -13,22 +14,16 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b  #v3.0.2
       with:
         token: ${{ secrets.PERSONAL_TOKEN_GH }}
 
-    - name: Maven cache
-      uses: actions/cache@v1
+    - name: Set up JDK
+      uses: actions/setup-java@2c7a4878f5d120bd643426d54ae1209b29cc01a3  #v3.4.1
       with:
-        path: ~/.m2/repository
-        key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}-${{ hashFiles('.github/workflows/tzdbupdate.yml') }}
-        restore-keys: |
-          ${{ runner.os }}-maven-
-
-    - name: Set up JDK 1.8
-      uses: actions/setup-java@v1
-      with:
-        java-version: 1.8
+        java-version: '8'
+        distribution: 'corretto'
+        cache: 'maven'
 
     - name: Maven version
       run: |
@@ -92,7 +87,7 @@ jobs:
     - name: Create Pull Request
       if: env.NOOP != 'true'
       id: createpr
-      uses: peter-evans/[email protected]
+      uses: peter-evans/create-pull-request@7380612b49221684fefa025244f2ef4008ae50ad  #v3.10.1
       env:
         GITHUB_TOKEN: ${{ secrets.PERSONAL_TOKEN_GH }}
       with:

diff --git a/README.md b/README.md
@@ -105,6 +105,17 @@ To report a security vulnerability, please use the [Tidelift security contact](h
 Tidelift will coordinate the fix and disclosure.
 
 
+### Development and Contributions
+Joda-Time is developed using standard [GitHub tools](https://github.com/JodaOrg/joda-time).
+A [checkstyle](https://checkstyle.sourceforge.io/) file is available, and PRs must comply with it.
+The project can be built using [Apache Maven](https://maven.apache.org/), such as <code>mvn clean install</code>.
+Continuous Integration takes place using [GitHub Actions](https://github.com/JodaOrg/joda-time/actions).
+Units tests are written in [JUnit](https://junit.org/) and run as part of the build and continuous integration.
+Changes via PR must include appropiate test coverage.
+
+Note that Joda-Time is considered to be a largely “finished” project. No major enhancements are planned. If using Java SE 8, please migrate to java.time (JSR-310).
+
+
 ### Release process
 
 * Update version (pom.xml, README.md, index.md, MANIFEST.MF, changes.xml)

diff --git a/pom.xml b/pom.xml
@@ -851,7 +851,9 @@
       </activation>
       <properties>
         <maven-surefire-plugin.version>2.21.0</maven-surefire-plugin.version>
+        <!-- two diferent ways to turn off doclint -->
         <additionalparam>-Xdoclint:none</additionalparam>
+        <doclint>none</doclint>
       </properties>
     </profile>
     <!-- Base deployment profile, activated by -Doss.repo -->
@@ -991,30 +993,30 @@
   <properties>
     <!-- Plugin version numbers -->
     <build-helper-maven-plugin.version>3.3.0</build-helper-maven-plugin.version>
-    <maven-assembly-plugin.version>3.1.0</maven-assembly-plugin.version>
+    <maven-assembly-plugin.version>3.4.2</maven-assembly-plugin.version>
     <maven-changes-plugin.version>2.12.1</maven-changes-plugin.version>
     <maven-checkstyle-plugin.version>2.17</maven-checkstyle-plugin.version>
-    <maven-clean-plugin.version>3.1.0</maven-clean-plugin.version>
-    <maven-compiler-plugin.version>3.8.0</maven-compiler-plugin.version>
-    <maven-deploy-plugin.version>2.8.2</maven-deploy-plugin.version>
-    <maven-dependency-plugin.version>3.1.1</maven-dependency-plugin.version>
-    <maven-enforcer-plugin.version>3.0.0-M1</maven-enforcer-plugin.version>
-    <maven-gpg-plugin.version>1.6</maven-gpg-plugin.version>
+    <maven-clean-plugin.version>3.2.0</maven-clean-plugin.version>
+    <maven-compiler-plugin.version>3.8.1</maven-compiler-plugin.version>
+    <maven-deploy-plugin.version>3.0.0</maven-deploy-plugin.version>
+    <maven-dependency-plugin.version>3.3.0</maven-dependency-plugin.version>
+    <maven-enforcer-plugin.version>3.1.0</maven-enforcer-plugin.version>
+    <maven-gpg-plugin.version>3.0.1</maven-gpg-plugin.version>
     <maven-install-plugin.version>2.5.2</maven-install-plugin.version>
-    <maven-jar-plugin.version>3.1.0</maven-jar-plugin.version>
-    <maven-javadoc-plugin.version>3.0.0-M1</maven-javadoc-plugin.version>
-    <maven-jxr-plugin.version>2.5</maven-jxr-plugin.version>
-    <maven-plugin-plugin.version>3.5.2</maven-plugin-plugin.version>
-    <maven-pmd-plugin.version>3.10.0</maven-pmd-plugin.version>
-    <maven-project-info-reports-plugin.version>3.0.0</maven-project-info-reports-plugin.version>
+    <maven-jar-plugin.version>3.2.2</maven-jar-plugin.version>
+    <maven-javadoc-plugin.version>3.4.0</maven-javadoc-plugin.version>
+    <maven-jxr-plugin.version>3.1.1</maven-jxr-plugin.version>
+    <maven-plugin-plugin.version>3.6.4</maven-plugin-plugin.version>
+    <maven-pmd-plugin.version>3.17.0</maven-pmd-plugin.version>
+    <maven-project-info-reports-plugin.version>3.4.0</maven-project-info-reports-plugin.version>
     <maven-release-plugin.version>2.5.3</maven-release-plugin.version>
     <maven-repository-plugin.version>2.4</maven-repository-plugin.version>
-    <maven-resources-plugin.version>3.1.0</maven-resources-plugin.version>
-    <maven-site-plugin.version>3.7.1</maven-site-plugin.version>
+    <maven-resources-plugin.version>3.3.0</maven-resources-plugin.version>
+    <maven-site-plugin.version>3.12.0</maven-site-plugin.version>
     <maven-source-plugin.version>3.2.1</maven-source-plugin.version>
     <!-- Stick with this version of surefire, see Java 5 comments above -->
     <maven-surefire-report-plugin.version>2.21.0</maven-surefire-report-plugin.version>
-    <maven-toolchains-plugin.version>1.1</maven-toolchains-plugin.version>
+    <maven-toolchains-plugin.version>3.1.0</maven-toolchains-plugin.version>
     <nexus-staging-maven-plugin.version>1.6.8</nexus-staging-maven-plugin.version>
     <!-- Properties for maven-compiler-plugin -->
     <maven.compiler.compilerVersion>1.5</maven.compiler.compilerVersion>