Merge pull request #6 from codesqueak/v400

Prep for 4.0.0 release

Author: codesqueak

README.md

@@ -6,8 +6,12 @@
 
 Z80Processor is a an implementation of the Mostek / Zilog Z80 processor in Java
 
-The code is not designed to be nice / clean / compact - however it is designed to be fast. It has been heavily profiled
-using [Yourkit](https://www.yourkit.com/) while running 'real' applications to identify hotspots.
+The code is not designed to be nice / clean / compact - however it is designed to be fast and easily checkable with every instruction 
+on its own switch / case statement. 
+
+If you are looking for a compact implementation, have a look at the Go implementation [here](https://github.com/codesqueak/z80)
+
+It code has been heavily profiled using [Yourkit](https://www.yourkit.com/) while running 'real' applications to identify hotspots.
 
 If you find this project useful, you may want to [__Buy me a Coffee!__ :coffee:](https://www.buymeacoffee.com/codesqueak) Thanks :thumbsup:
 
@@ -23,10 +27,9 @@ Linux
 
 The build may take a few minutes as it includes a comprehensive test suite for the Z80 instruction set.
 
+## Java Version
 
-## Using Jenkins
-
-The project includes a Jenkins file to control a pipeline build.  At present the available version of the Jacoco plugin (2.0.1 at time of writing) does not support a 'publisher'.  The build was tested using a hand built plugin from the master branch of the  [project](https://github.com/jenkinsci/jacoco-plugin)
+Version 4.0.0 onwards of the emulator require Java 17 or above
 
 ### Include Using Maven
 
@@ -35,15 +38,15 @@ The project includes a Jenkins file to control a pipeline build.  At present the
 <dependency>
     <groupId>com.codingrodent.microprocessor</groupId>
     <artifactId>Z80Processor</artifactId>
-    <version>3.2.0</version>
+    <version>4.0.0</version>
 </dependency>
 ```
 
 ### Include Using Gradle
 
 ```
 // https://mvnrepository.com/artifact/com.codingrodent.microprocessor/Z80Processor
-compile group: 'com.codingrodent.microprocessor', name: 'Z80Processor', version: '3.2.0'
+compile group: 'com.codingrodent.microprocessor', name: 'Z80Processor', version: '4.0.0'
 ```
 
 ## Undocumented instruction

build.gradle

@@ -18,6 +18,7 @@ plugins {
     id 'idea'
     id 'maven-publish'
     id 'jacoco'
+    id 'signing'
 }
 
 
@@ -27,6 +28,8 @@ apply plugin: 'com.jfrog.artifactory'
 java {
     sourceCompatibility = JavaVersion.VERSION_17
     targetCompatibility = JavaVersion.VERSION_17
+    withJavadocJar()
+    withSourcesJar()
 }
 
 group = 'com.codingrodent.microprocessor'
@@ -50,55 +53,12 @@ jar {
 }
 
 
-task sourcesJar(type: Jar, dependsOn: classes) {
-    classifier = 'sources'
-    from sourceSets.main.allSource
-}
 
 javadoc {
     options.addBooleanOption('html5', true)
 }
 
-task javadocJar(type: Jar, dependsOn: javadoc) {
-    classifier = 'javadoc'
-    from javadoc.destinationDir
-}
-
-task createPom {
-    doLast {
-        pom
-        {
-            project {
-                artifactId 'Z80Processor'
-                groupId 'com.codingrodent.microprocessor'
-                name 'com.codingrodent.microprocessor.Z80Processor'
-                description 'A Z80 Microprocessor core in Java'
-                url 'https://github.com/codesqueak/Z80Processor'
-                scm {
-                    url 'https://github.com/codesqueak/Z80Processor'
-                    connection 'scm:git:git://github.com/codesqueak/Z80Processor.git'
-                    developerConnection 'scm:git:ssh://github.com:codesqueak/Z80Processor.git'
-                }
 
-                licenses {
-                    license {
-                        name 'The Apache Software License, Version 2.0'
-                        url 'http://www.apache.org/licenses/LICENSE-2.0.txt'
-                        distribution 'repo'
-                    }
-                }
-                developers {
-                    developer {
-                        id 'codesqueak'
-                        name 'codesqueak'
-                        organizationUrl 'http://www.codesqueak.com'
-                        //  organization 'codesqueak'
-                    }
-                }
-            }
-        }.writeTo("$buildDir/libs/" + projectName + "-" + version + ".pom")
-    }
-}
 
 artifacts {
     archives sourcesJar
@@ -145,10 +105,43 @@ publishing {
     publications {
         mavenJava(MavenPublication) {
             from components.java
+            pom {
+                artifactId= 'Z80Processor'
+                groupId= 'com.codingrodent.microprocessor'
+                name= 'com.codingrodent.microprocessor.Z80Processor'
+                description= 'A Z80 Microprocessor core in Java'
+                url= 'https://github.com/codesqueak/Z80Processor'
+                scm {
+                    url= 'https://github.com/codesqueak/Z80Processor'
+                    connection= 'scm:git:git://github.com/codesqueak/Z80Processor.git'
+                    developerConnection= 'scm:git:ssh://github.com:codesqueak/Z80Processor.git'
+                }
+                licenses {
+                    license {
+                        name= 'The Apache Software License, Version 2.0'
+                        url= 'http://www.apache.org/licenses/LICENSE-2.0.txt'
+                        distribution ='repo'
+                    }
+                }
+                developers {
+                    developer {
+                        id= 'codesqueak'
+                        name= 'codesqueak'
+                        organizationUrl ='http://www.codesqueak.com'
+                        //  organization 'codesqueak'
+                    }
+                }
+
+            }
         }
     }
 }
 
+signing {
+    sign(publishing.publications["mavenJava"])
+}
+
+
 artifactory {
     contextUrl = "${artifactory_contextUrl}"   //The base Artifactory URL if not overridden by the publisher/resolver
     publish {

gradle.properties

@@ -6,7 +6,3 @@ projectName=Z80Processor
 projectVersionMajor=4
 projectVersionMinor=0
 projectVersionBuild=0
-#
-artifactory_user=admin
-artifactory_password=APdDpsMZH3NzE9wS8eKcyxZi44
-artifactory_contextUrl=http://172.16.1.7:9081/artifactory

notes.md

@@ -0,0 +1,18 @@
+# Build & Deploy Notes
+
+`./gradlew clean build test publishToMavenLocal`
+
+This will generate the build products in your local maven repo `~/.m2`
+
+## Signing Requirements
+
+To sign the products of the build, you will need to have generated a signing key using [gpg](https://www.gnupg.org/documentation/howtos.html)
+
+The following field are required in the gradle.properties
+
+`signing.keyId=< last 8 symbols of the key >`  
+`signing.password=< password for the private key >`  
+`signing.secretKeyRingFile=< file location/.gnupg/secring.gpg >`  
+
+To see your key, `use gpg -k`
+