Merge branch 'release/4.0.0'

Release: com.io7m.jaffirm 4.0.0 Change: (Backwards incompatible) Require JDK 17
io7m-com · Apr 9, 2022 · f1826b2 · f1826b2
2 parents 10f2c67 + db3718e
commit f1826b2
Show file tree

Hide file tree

Showing 43 changed files with 177 additions and 124 deletions.
diff --git a/.github/workflows/main-openjdk_current-linux.yml b/.github/workflows/main-openjdk_current-linux.yml
@@ -0,0 +1,19 @@
+name: main-openjdk_current-linux
+
+on:
+  push:
+    branches: [ develop, feature/*, release/* ]
+  pull_request:
+    branches: [ develop ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: JDK
+        uses: actions/setup-java@v1
+        with:
+          java-version: 17
+      - name: Build
+        run: mvn --errors clean verify site
diff --git a/.github/workflows/main-openjdk_current-windows.yml b/.github/workflows/main-openjdk_current-windows.yml
@@ -0,0 +1,19 @@
+name: main-openjdk_current-windows
+
+on:
+  push:
+    branches: [ develop, feature/*, release/* ]
+  pull_request:
+    branches: [ develop ]
+
+jobs:
+  build:
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: JDK
+        uses: actions/setup-java@v1
+        with:
+          java-version: 17
+      - name: Build
+        run: mvn --errors clean verify site
diff --git a/.github/workflows/main-openjdk_lts-linux.yml b/.github/workflows/main-openjdk_lts-linux.yml
@@ -0,0 +1,23 @@
+name: main-openjdk_lts-linux
+
+on:
+  push:
+    branches: [ develop, feature/*, release/* ]
+  pull_request:
+    branches: [ develop ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: JDK
+        uses: actions/setup-java@v1
+        with:
+          java-version: 17
+      - name: Build
+        run: mvn --errors clean verify site
+      - name: Coverage
+        uses: codecov/codecov-action@v1
+        with:
+          file: com.io7m.jaffirm.tests/target/site/jacoco/jacoco.xml
diff --git a/.jenkins b/.jenkins
diff --git a/.travis.yml b/.travis.yml
diff --git a/README-CHANGES.xml b/README-CHANGES.xml
@@ -1,22 +1,22 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <c:changelog project="com.io7m.jaffirm" xmlns:c="urn:com.io7m.changelog:4.0">
   <c:releases>
-    <c:release date="2016-08-26T00:00:00+00:00" ticket-system="com.github.io7m.jaffirm" version="0.1.0">
+    <c:release date="2016-08-26T00:00:00+00:00" is-open="false" ticket-system="com.github.io7m.jaffirm" version="0.1.0">
       <c:changes>
         <c:change date="2016-08-26T00:00:00+00:00" summary="Initial release."/>
       </c:changes>
     </c:release>
-    <c:release date="2017-02-22T00:00:00+00:00" ticket-system="com.github.io7m.jaffirm" version="1.0.0">
+    <c:release date="2017-02-22T00:00:00+00:00" is-open="false" ticket-system="com.github.io7m.jaffirm" version="1.0.0">
       <c:changes>
         <c:change date="2017-02-22T00:00:00+00:00" summary="Initial API-stable release."/>
       </c:changes>
     </c:release>
-    <c:release date="2017-04-05T00:00:00+00:00" ticket-system="com.github.io7m.jaffirm" version="1.0.1">
+    <c:release date="2017-04-05T00:00:00+00:00" is-open="false" ticket-system="com.github.io7m.jaffirm" version="1.0.1">
       <c:changes>
         <c:change date="2017-04-05T00:00:00+00:00" summary="Rename project. Use the new primogenitor POM and 2017 project conventions. Move documentation to kstructural."/>
       </c:changes>
     </c:release>
-    <c:release date="2017-04-07T00:00:00+00:00" ticket-system="com.github.io7m.jaffirm" version="1.1.0">
+    <c:release date="2017-04-07T00:00:00+00:00" is-open="false" ticket-system="com.github.io7m.jaffirm" version="1.1.0">
       <c:changes>
         <c:change date="2017-04-07T00:00:00+00:00" summary="Add variadic preconditions/postconditions/invariants.">
           <c:tickets>
@@ -25,37 +25,42 @@
         </c:change>
       </c:changes>
     </c:release>
-    <c:release date="2017-11-04T00:00:00+00:00" ticket-system="com.github.io7m.jaffirm" version="2.0.0">
+    <c:release date="2017-11-04T00:00:00+00:00" is-open="false" ticket-system="com.github.io7m.jaffirm" version="2.0.0">
       <c:changes>
         <c:change compatible="false" date="2017-11-04T00:00:00+00:00" summary="Require JDK 9 and publish a Java 9 module."/>
         <c:change compatible="false" date="2017-11-04T00:00:00+00:00" summary="Remove com.io7m.jnull dependency."/>
       </c:changes>
     </c:release>
-    <c:release date="2019-06-23T00:00:00+00:00" ticket-system="com.github.io7m.jaffirm" version="3.0.0">
+    <c:release date="2019-06-23T00:00:00+00:00" is-open="false" ticket-system="com.github.io7m.jaffirm" version="3.0.0">
       <c:changes>
         <c:change compatible="false" date="2018-05-17T00:00:00+00:00" summary="Remove checkstyle module and use common checkstyle rules"/>
         <c:change date="2018-05-17T00:00:00+00:00" summary="Use newest primogenitor"/>
         <c:change compatible="false" date="2019-06-23T00:00:00+00:00" summary="Require JDK 11"/>
       </c:changes>
     </c:release>
-    <c:release date="2019-10-16T00:00:00+00:00" ticket-system="com.github.io7m.jaffirm" version="3.0.1">
+    <c:release date="2019-10-16T00:00:00+00:00" is-open="false" ticket-system="com.github.io7m.jaffirm" version="3.0.1">
       <c:changes>
         <c:change date="2019-10-16T00:00:00+00:00" summary="Use correct junreachable 3.0.0 release"/>
       </c:changes>
     </c:release>
-    <c:release date="2020-04-03T00:00:00+00:00" ticket-system="com.github.io7m.jaffirm" version="3.0.2">
+    <c:release date="2020-04-03T00:00:00+00:00" is-open="false" ticket-system="com.github.io7m.jaffirm" version="3.0.2">
       <c:changes>
         <c:change date="2020-04-03T00:00:00+00:00" summary="Use primogenitor 3.6.0"/>
       </c:changes>
     </c:release>
-    <c:release date="2020-04-03T00:00:00+00:00" ticket-system="com.github.io7m.jaffirm" version="3.0.3">
+    <c:release date="2020-04-03T00:00:00+00:00" is-open="false" ticket-system="com.github.io7m.jaffirm" version="3.0.3">
       <c:changes>
         <c:change date="2020-04-03T00:00:00+00:00" summary="Use primogenitor 3.7.0"/>
       </c:changes>
     </c:release>
-    <c:release date="2020-04-03T13:51:26+00:00" ticket-system="com.github.io7m.jaffirm" version="3.0.4">
+    <c:release date="2020-04-03T00:00:00+00:00" is-open="false" ticket-system="com.github.io7m.jaffirm" version="3.0.4">
       <c:changes>
-        <c:change date="2020-04-03T13:51:26+00:00" summary="Use primogenitor 3.8.0"/>
+        <c:change date="2020-04-03T00:00:00+00:00" summary="Use primogenitor 3.8.0"/>
+      </c:changes>
+    </c:release>
+    <c:release date="2022-04-09T12:44:57+00:00" is-open="false" ticket-system="com.github.io7m.jaffirm" version="4.0.0">
+      <c:changes>
+        <c:change compatible="false" date="2022-04-09T00:00:00+00:00" summary="Require JDK 17"/>
       </c:changes>
     </c:release>
   </c:releases>

diff --git a/README.md b/README.md
@@ -1,11 +1,15 @@
 jaffirm
 ===
 
-[![Travis](https://img.shields.io/travis/io7m/jaffirm.png?style=flat-square)](https://travis-ci.org/io7m/jaffirm)
-[![Maven Central](https://img.shields.io/maven-central/v/com.io7m.jaffirm/com.io7m.jaffirm.png?style=flat-square)](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.io7m.jaffirm%22)
+[![Maven Central](https://img.shields.io/maven-central/v/com.io7m.jaffirm/com.io7m.jaffirm.svg?style=flat-square)](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.io7m.jaffirm%22)
 [![Maven Central (snapshot)](https://img.shields.io/nexus/s/https/oss.sonatype.org/com.io7m.jaffirm/com.io7m.jaffirm.svg?style=flat-square)](https://oss.sonatype.org/content/repositories/snapshots/com/io7m/jaffirm/)
-[![Codacy grade](https://img.shields.io/codacy/grade/8e7105dcfbf2437aa3402fbdb0269f89.png?style=flat-square)](https://www.codacy.com/app/github_79/jaffirm)
-[![Codecov](https://img.shields.io/codecov/c/github/io7m/jaffirm.png?style=flat-square)](https://codecov.io/gh/io7m/jaffirm)
+[![Codecov](https://img.shields.io/codecov/c/github/io7m/jaffirm.svg?style=flat-square)](https://codecov.io/gh/io7m/jaffirm)
 
 ![jaffirm](./src/site/resources/jaffirm.jpg?raw=true)
 
+| JVM             | Platform | Status |
+|-----------------|----------|--------|
+| OpenJDK LTS     | Linux    | [![Build (OpenJDK LTS, Linux)](https://img.shields.io/github/workflow/status/io7m/jaffirm/main-openjdk_lts-linux)](https://github.com/io7m/jaffirm/actions?query=workflow%3Amain-openjdk_lts-linux) |
+| OpenJDK Current | Linux    | [![Build (OpenJDK Current, Linux)](https://img.shields.io/github/workflow/status/io7m/jaffirm/main-openjdk_current-linux)](https://github.com/io7m/jaffirm/actions?query=workflow%3Amain-openjdk_current-linux)
+| OpenJDK Current | Windows  | [![Build (OpenJDK Current, Windows)](https://img.shields.io/github/workflow/status/io7m/jaffirm/main-openjdk_current-windows)](https://github.com/io7m/jaffirm/actions?query=workflow%3Amain-openjdk_current-windows)
+
diff --git a/com.io7m.jaffirm.core/pom.xml b/com.io7m.jaffirm.core/pom.xml
@@ -8,21 +8,31 @@
   <parent>
     <groupId>com.io7m.jaffirm</groupId>
     <artifactId>com.io7m.jaffirm</artifactId>
-    <version>3.0.4</version>
+    <version>4.0.0</version>
   </parent>
   <artifactId>com.io7m.jaffirm.core</artifactId>
 
   <packaging>jar</packaging>
   <name>com.io7m.jaffirm.core</name>
   <description>Contract checking (Core)</description>
-  <url>http://io7m.github.io/jaffirm/</url>
+  <url>https://www.io7m.com/software/jaffirm</url>
 
   <dependencies>
     <dependency>
       <groupId>com.io7m.junreachable</groupId>
       <artifactId>com.io7m.junreachable.core</artifactId>
     </dependency>
 
+    <dependency>
+      <groupId>org.osgi</groupId>
+      <artifactId>org.osgi.annotation.bundle</artifactId>
+      <scope>provided</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.osgi</groupId>
+      <artifactId>org.osgi.annotation.versioning</artifactId>
+      <scope>provided</scope>
+    </dependency>
     <dependency>
       <groupId>org.immutables</groupId>
       <artifactId>value</artifactId>
@@ -37,35 +47,6 @@
 
   <build>
     <plugins>
-      <!-- Check style -->
-      <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
-        <artifactId>maven-checkstyle-plugin</artifactId>
-      </plugin>
-
-      <!-- Analyze semantic versioning -->
-      <plugin>
-        <groupId>biz.aQute.bnd</groupId>
-        <artifactId>bnd-baseline-maven-plugin</artifactId>
-      </plugin>
-
-      <!-- Spot bugs -->
-      <plugin>
-        <groupId>com.github.spotbugs</groupId>
-        <artifactId>spotbugs-maven-plugin</artifactId>
-      </plugin>
-
-      <!-- Produce OSGi manifest -->
-      <plugin>
-        <groupId>biz.aQute.bnd</groupId>
-        <artifactId>bnd-maven-plugin</artifactId>
-        <configuration>
-          <bnd><![CDATA[
-            Export-Package: com.io7m.jaffirm.core
-]]></bnd>
-        </configuration>
-      </plugin>
-
       <!-- Determine test coverage -->
       <plugin>
         <groupId>org.jacoco</groupId>

diff --git a/com.io7m.jaffirm.core/src/main/java/com/io7m/jaffirm/core/ContractConditionType.java b/com.io7m.jaffirm.core/src/main/java/com/io7m/jaffirm/core/ContractConditionType.java
@@ -1,5 +1,5 @@
 /*
- * Copyright © 2016 <[email protected]> http://io7m.com
+ * Copyright © 2016 Mark Raynsford <[email protected]> https://www.io7m.com
  *
  * Permission to use, copy, modify, and/or distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above

diff --git a/com.io7m.jaffirm.core/src/main/java/com/io7m/jaffirm/core/ContractDoubleConditionType.java b/com.io7m.jaffirm.core/src/main/java/com/io7m/jaffirm/core/ContractDoubleConditionType.java
@@ -1,5 +1,5 @@
 /*
- * Copyright © 2016 <[email protected]> http://io7m.com
+ * Copyright © 2016 Mark Raynsford <[email protected]> https://www.io7m.com
  *
  * Permission to use, copy, modify, and/or distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above

diff --git a/com.io7m.jaffirm.core/src/main/java/com/io7m/jaffirm/core/ContractException.java b/com.io7m.jaffirm.core/src/main/java/com/io7m/jaffirm/core/ContractException.java
@@ -1,5 +1,5 @@
 /*
- * Copyright © 2016 <[email protected]> http://io7m.com
+ * Copyright © 2016 Mark Raynsford <[email protected]> https://www.io7m.com
  *
  * Permission to use, copy, modify, and/or distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above

diff --git a/com.io7m.jaffirm.core/src/main/java/com/io7m/jaffirm/core/ContractIntConditionType.java b/com.io7m.jaffirm.core/src/main/java/com/io7m/jaffirm/core/ContractIntConditionType.java
@@ -1,5 +1,5 @@
 /*
- * Copyright © 2016 <[email protected]> http://io7m.com
+ * Copyright © 2016 Mark Raynsford <[email protected]> https://www.io7m.com
  *
  * Permission to use, copy, modify, and/or distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above

diff --git a/com.io7m.jaffirm.core/src/main/java/com/io7m/jaffirm/core/ContractLongConditionType.java b/com.io7m.jaffirm.core/src/main/java/com/io7m/jaffirm/core/ContractLongConditionType.java
@@ -1,5 +1,5 @@
 /*
- * Copyright © 2016 <[email protected]> http://io7m.com
+ * Copyright © 2016 Mark Raynsford <[email protected]> https://www.io7m.com
  *
  * Permission to use, copy, modify, and/or distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above

diff --git a/com.io7m.jaffirm.core/src/main/java/com/io7m/jaffirm/core/Contracts.java b/com.io7m.jaffirm.core/src/main/java/com/io7m/jaffirm/core/Contracts.java
@@ -1,5 +1,5 @@
 /*
- * Copyright © 2016 <[email protected]> http://io7m.com
+ * Copyright © 2016 Mark Raynsford <[email protected]> https://www.io7m.com
  *
  * Permission to use, copy, modify, and/or distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above

diff --git a/com.io7m.jaffirm.core/src/main/java/com/io7m/jaffirm/core/InvariantViolationException.java b/com.io7m.jaffirm.core/src/main/java/com/io7m/jaffirm/core/InvariantViolationException.java
@@ -1,5 +1,5 @@
 /*
- * Copyright © 2016 <[email protected]> http://io7m.com
+ * Copyright © 2016 Mark Raynsford <[email protected]> https://www.io7m.com
  *
  * Permission to use, copy, modify, and/or distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above

diff --git a/com.io7m.jaffirm.core/src/main/java/com/io7m/jaffirm/core/Invariants.java b/com.io7m.jaffirm.core/src/main/java/com/io7m/jaffirm/core/Invariants.java
@@ -1,5 +1,5 @@
 /*
- * Copyright © 2016 <[email protected]> http://io7m.com
+ * Copyright © 2016 Mark Raynsford <[email protected]> https://www.io7m.com
  *
  * Permission to use, copy, modify, and/or distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above

diff --git a/...o7m.jaffirm.core/src/main/java/com/io7m/jaffirm/core/PostconditionViolationException.java b/...o7m.jaffirm.core/src/main/java/com/io7m/jaffirm/core/PostconditionViolationException.java
@@ -1,5 +1,5 @@
 /*
- * Copyright © 2016 <[email protected]> http://io7m.com
+ * Copyright © 2016 Mark Raynsford <[email protected]> https://www.io7m.com
  *
  * Permission to use, copy, modify, and/or distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above

diff --git a/com.io7m.jaffirm.core/src/main/java/com/io7m/jaffirm/core/Postconditions.java b/com.io7m.jaffirm.core/src/main/java/com/io7m/jaffirm/core/Postconditions.java
@@ -1,5 +1,5 @@
 /*
- * Copyright © 2016 <[email protected]> http://io7m.com
+ * Copyright © 2016 Mark Raynsford <[email protected]> https://www.io7m.com
  *
  * Permission to use, copy, modify, and/or distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above

diff --git a/...io7m.jaffirm.core/src/main/java/com/io7m/jaffirm/core/PreconditionViolationException.java b/...io7m.jaffirm.core/src/main/java/com/io7m/jaffirm/core/PreconditionViolationException.java
@@ -1,5 +1,5 @@
 /*
- * Copyright © 2016 <[email protected]> http://io7m.com
+ * Copyright © 2016 Mark Raynsford <[email protected]> https://www.io7m.com
  *
  * Permission to use, copy, modify, and/or distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above

diff --git a/com.io7m.jaffirm.core/src/main/java/com/io7m/jaffirm/core/Preconditions.java b/com.io7m.jaffirm.core/src/main/java/com/io7m/jaffirm/core/Preconditions.java
@@ -1,5 +1,5 @@
 /*
- * Copyright © 2016 <[email protected]> http://io7m.com
+ * Copyright © 2016 Mark Raynsford <[email protected]> https://www.io7m.com
  *
  * Permission to use, copy, modify, and/or distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above

diff --git a/com.io7m.jaffirm.core/src/main/java/com/io7m/jaffirm/core/SafeApplication.java b/com.io7m.jaffirm.core/src/main/java/com/io7m/jaffirm/core/SafeApplication.java
@@ -1,5 +1,5 @@
 /*
- * Copyright © 2017 <[email protected]> http://io7m.com
+ * Copyright © 2016 Mark Raynsford <[email protected]> https://www.io7m.com
  *
  * Permission to use, copy, modify, and/or distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above

diff --git a/com.io7m.jaffirm.core/src/main/java/com/io7m/jaffirm/core/Violations.java b/com.io7m.jaffirm.core/src/main/java/com/io7m/jaffirm/core/Violations.java
@@ -1,5 +1,5 @@
 /*
- * Copyright © 2017 <[email protected]> http://io7m.com
+ * Copyright © 2016 Mark Raynsford <[email protected]> https://www.io7m.com
  *
  * Permission to use, copy, modify, and/or distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above

diff --git a/com.io7m.jaffirm.core/src/main/java/com/io7m/jaffirm/core/package-info.java b/com.io7m.jaffirm.core/src/main/java/com/io7m/jaffirm/core/package-info.java
@@ -1,5 +1,5 @@
 /*
- * Copyright © 2016 <[email protected]> http://io7m.com
+ * Copyright © 2016 Mark Raynsford <[email protected]> https://www.io7m.com
  *
  * Permission to use, copy, modify, and/or distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
@@ -18,5 +18,9 @@
  * Core types and functions.
  */
 
+@Export
+@Version("4.0.0")
 package com.io7m.jaffirm.core;
 
+import org.osgi.annotation.bundle.Export;
+import org.osgi.annotation.versioning.Version;
diff --git a/com.io7m.jaffirm.core/src/main/java/module-info.java b/com.io7m.jaffirm.core/src/main/java/module-info.java
@@ -1,5 +1,5 @@
 /*
- * Copyright © 2017 <[email protected]> http://io7m.com
+ * Copyright © 2016 Mark Raynsford <[email protected]> https://www.io7m.com
  *
  * Permission to use, copy, modify, and/or distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
@@ -20,8 +20,10 @@
 
 module com.io7m.jaffirm.core
 {
-  requires static org.immutables.value;
   requires static com.io7m.immutables.style;
+  requires static org.immutables.value;
+  requires static org.osgi.annotation.bundle;
+  requires static org.osgi.annotation.versioning;
 
   requires com.io7m.junreachable.core;
+55 −39		com.io7m.jenkins.github.txt
+84 −0		com.io7m.jenkins.github.windowless.txt
+1 −1		notify.sh