Spike

.github/workflows/install.yml

@@ -0,0 +1,42 @@
+# This is a basic workflow to help you get started with Actions
+
+name: Maven Install
+
+# Controls when the action will run. 
+on:
+  # Triggers the workflow on push or pull request events but not for the master branch
+  push:
+    branches:
+      - '*'
+      - '!main'
+
+# Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+    #when repo is slow then it can take north of 10 minutes to validate
+    timeout-minutes: 20
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v2
+      # see https://github.com/actions/setup-java
+      - name: Set up JDK 11 and .m2/settings.xml
+        uses: actions/setup-java@v1
+        with:
+          java-version: 11
+          server-id: ossrh
+      - name: Configure Git user
+        run: |
+          git config user.name github-actions
+          git config user.email github-actions@github.com
+      # see https://blog.frankel.ch/github-actions-maven-releases/
+      - id: install
+        name: maven install
+        run: mvn --no-transfer-progress --batch-mode install
+

.github/workflows/release-and-publish.yml

@@ -0,0 +1,56 @@
+# This is a basic workflow to help you get started with Actions
+
+name: Release and  Publish to OSSRH (maven central)
+
+# Controls when the action will run. 
+on:
+  # Triggers the workflow on push or pull request events but only for the master branch
+  push:
+    branches: [ main ]
+
+# Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+    #when repo is slow then it can take north of 10 minutes to validate
+    timeout-minutes: 20
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v2
+      # see https://github.com/actions/setup-java
+      - name: Set up JDK 11 and .m2/settings.xml
+        uses: actions/setup-java@v1
+        with:
+          java-version: 11
+          server-id: ossrh
+          server-username: MAVEN_USERNAME # env variable for username in release:perform
+          server-password: MAVEN_CENTRAL_TOKEN # env variable for token in release:perform
+          gpg-private-key: ${{ secrets.OSSRH_GPG_SECRET_KEY }} # Value of the GPG private key to import
+          gpg-passphrase: MAVEN_GPG_PASSPHRASE # env variable for GPG private key passphrase
+      - name: Configure Git user
+        run: |
+          git config user.name github-actions
+          git config user.email github-actions@github.com
+      # see https://blog.frankel.ch/github-actions-maven-releases/
+      - id: release-prepare
+        name: release prepare
+        env:
+          MAVEN_GPG_PASSPHRASE: ${{ secrets.OSSRH_GPG_SECRET_KEY_PASSWORD }}
+        run: mvn --no-transfer-progress --batch-mode release:prepare
+      - id: release-perform
+        name: release perform
+        env:
+          MAVEN_USERNAME: ${{ secrets.OSSRH_USERNAME }}
+          MAVEN_CENTRAL_TOKEN: ${{ secrets.OSSRH_TOKEN }}
+          MAVEN_GPG_PASSPHRASE: ${{ secrets.OSSRH_GPG_SECRET_KEY_PASSWORD }}
+        run: |
+          mvn \
+            --no-transfer-progress \
+            --batch-mode \
+            release:perform

.gitignore

@@ -21,3 +21,8 @@
 
 # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
 hs_err_pid*
+**/.project
+**/.settings
+**/.classpath
+**/target
+**/bin

README.md

@@ -1,2 +1,31 @@
-# fix-orchestra-avro
-The repository contains utilities for integration of FIX Orchestra and Apache Avro
+# Repository To Avro Tools 
+
+![](FIXorchestraLogo.png)
+
+The repository contains utilities for integration of FIX Orchestra and Apache Avro.
+
+* FIX Orchestra is intended to provide a standard and some reference implementations for machine readable rules of engagement between counterparties. A customisation of the FIX Orchestra specification for a specific Rules of Engagement is know as an "orchestration". FIX Orchestra is intended to be customised.
+
+* [Apache Avro™](https://avro.apache.org/docs/current/index.html) is a data serialization system. One the features it provides is a binary data format that is widely used in [Apache Kafka](https://kafka.apache.org/) integrations. Avro can similarly be used in JMS implementations and other use cases. Avro data serialization uses Avro schemas defined in JSON. 
+
+Since FIX version 5.0 there has been a logical distinction between the FIX transport and the FIX Application messages. FIX *Messages* can be exchanged using diverse transports. The generation of Avro Schemas from a FIX Orchestra repository supports cases where Avro is used for serialisation of FIX *Messages*. Using Avro schemas generated from FIX Orchestra may be challenging. Please see the ```repository-to-avro-examples```.
+
+These challenges can be mitigated by customising the FIX Orchestration to reduce its complexity. FIX Orchestra is intended to be customised to adapt the Orchestration to the users' specific requirements and in this case to Avro. Without customisation a full FIX ExecutionReport, for example, won't compile : ``` error: code too large```.  Customisation may include the removal of fields associated with the FIX transport (Session).
+
+This Avro schema generation creates separate schemas for each FIX *Message*. Generated schemas artefacts may be used as constituents of other schemas, for example one may elect to use a union to permit a schema to contain more than one *Message" type. To allow flexibilty according to the users' requirements the repository-to-avro schema generation does not prescribe the containing/envelope schema.
+
+```repository-to-avro``` supports options for the schema generation, please see the readme documents in the child projects for details 
+
+At time of writing the FIX Standard Orchestration needs some changes to work with Avro code generation for Java. This is accomplished with a simple ```xslt``` transformation that can be found in the build. 
+
+```xslt```  may be used for schema customisation but please refer to the FIX Orchestra projects for additional tools.
+
+## Modules
+
+* repository-to-avro : Generates an Avro schema corresponding to the supplied FIX Orchestra repository.
+
+* repository-to-avro-maven-plugin : Faciliates FIX Orchestra repository to Avro Schema generation in [Apache Maven](https://maven.apache.org/) projects.
+
+* repository-to-avro-examples : Examples using the generated schema
+    * repository-to-avro-example : Example using the generated schema
+    * repository-to-avro-example-normalised  : Example using the generated schema with normalised Components and Groups written to separate files.