HGK Release Notes

1. HGK 7.0.0

1.1. Bug Fixes

1.1.1. Deployment Packaging

  • BREAKING: Deployment pom.xml generation now uses the deployment instance name in the assembly plugin, which changes both the name and the location of the resulting deployment jar. A jar is now written to missions/<Mission>/<Target>/<DeploymentInstance>/<DeploymentInstance>.jar, rather than to a directory named after the deployment type. This also fixes the previous behaviour where a target hosting two deployment instances of the same deployment type produced only one jar.

  • Anything that reads the deployment jar directly — scripts, CI pipelines and tutorial material — must be updated to the new name and location.

2. HGK 6.3.0

2.1. Features

2.1.1. Build

  • Deployments within a target marked as a placeholder are no longer built. This improves build times for missions with many placeholder targets, and removes the limit that build time previously placed on how many could be used.

2.1.2. Code Generation

  • Removed the remoteTargetIds workaround for send and notify operations from container init data and deploy files.

3. HGK 6.2.0

3.1. Features

3.1.1. Python Scripting

  • Python code generation now handles more services.

3.1.2. Component Generation

  • Send and notify operation code is no longer generated into component files when implementation access is None.

3.2. Bug Fixes

3.2.1. Code Generation

  • Fixed generated gRPC code so that service messages and service operations containing lists, or custom types with lists, no longer cause compile errors.

  • Fixed erroneous autogenerated comments.

3.3. Dependencies

  • Updated to Tooling Core 7.4.0.

4. HGK 6.0.0

4.1. Features

4.1.1. Packaging

  • As part of making the release, model XSD files are now included in the Groundkit archive.

4.1.2. Tooling

  • Added comments to tooling-controlled files to discourage manual editing.

  • Updated Helix Groundkit repository to use the latest tooling core and model version.

4.1.3. Service Generation

  • Added SelectionId to Send operation generation.

  • Added SelectionId to Notify operation generation.

4.1.4. Multirow Parameters

  • Developers can now access firstRow, lastRow, and resize parameters for multirow parameter gets.

4.2. Bug Fixes

4.2.1. Service Provisioning

  • Fixed an issue where remote service providers were set up incorrectly when multiple providers existed for the same service.

4.2.2. Code Generation

  • Fixed compile issues in generated gRPC Service Mapper when service message arguments used upper camel case.

4.2.3. Build / Packaging

  • Removed redundant groupId entries in artefact pom.xml files.

  • Fixed whitespace issues in Deployment InitData files.

4.2.4. Exception Handling

  • Updated to use component.PAS exceptions instead of GenOneBaseException with correct status codes.

  • Updated to use component.AAS exceptions instead of GenOneBaseException with correct status codes.

4.3. Dependencies

  • Updated to Tooling-Core 7.0.0.

  • Updated to Model version 7.0.0.

5. HGK 5.2.0

5.1. Features

5.1.1. Python Scripting

  • Added Python scripting codegen command to hgk.

6. HGK 5.1.0

6.1. Features

6.1.1. Services

  • If a Service contains Send operations, generated protobuf files now include a unary RPC for these.

  • If a Service contains Notify operations, generated protobuf files now include a server-streaming RPC for these.

  • Added a workaround for an issue related to send and notify operations on open bindings.

6.2. Bug Fixes

6.2.1. Service Objects

  • Fixed an ordering bug in generated copy methods.

  • Service Object copy methods now use ordered Maps within the copies.

7. HGK 5.0.3

7.1. Bug Fixes

7.1.1. Deployment Initialisation

  • Components are now initialised in the order that they are declared in a Deployment Type. This required changes in the GenOne Java language implementation and updates to Deployment templates.

7.1.2. Packaging

  • Fixed an issue where external bundle dependencies were not included in deployment JARs.

7.2. Changes

7.2.1. Model Representation

  • Updated the repository to use Model Service Objects. There was no change to hgk functionality.

7.3. Dependencies

  • Uses GenOne Java 6.0.1.

  • Uses Model Version 5.0.0.

  • Uses Tooling Core 4.0.3.

8. HGK 5.0.2

8.1. Bug Fixes

8.1.1. Build Tooling

  • Fixed Maven invoker handling of streams.

9. HGK 5.0.1

9.1. Bug Fixes

9.1.1. Service Objects

  • Fixed circular issues with copy functionality of Service Objects.

10. HGK 5.0.0

10.1. Changes

10.1.1. CLI Output

  • Updated the description output produced by the Groundkit CLI.

10.1.2. Distributed Systems

  • Added support for specifying the same Service Provision in multiple Routes.

  • Generated DeploymentServiceManager includes a mapping from ServiceProviderIds to ServiceProvisionPoints.

  • Generated service classes were updated to handle maps of local and remote providers instead of lists.

10.1.3. Code Generation

  • Updated generated files to remove references to the serviceProviderId field in ServiceProvisionPoint. The Service Dispatcher locates ServiceProviderIds using the generated mapping logic.

10.2. Breaking Changes

10.2.1. Service Objects

  • Added copy functionality to Service Objects, Service Object Reference Infos, and CustomTypes.

10.3. Dependencies

  • Uses GenOne Java 6.0.0.

11. HGK 4.0.1

11.1. Dependencies

11.1.1. Security

  • Updated gRPC and Protobuf dependencies to address a published security vulnerability.

11.1.2. Language Implementation

  • Uses GenOne Java 5.0.1.

12. HGK 4.0.0

12.1. Bug Fixes

12.1.1. Task Scheduling

  • PeriodicTask period and offset are now interpreted as seconds and stored as a Java double.

12.1.2. Code Generation

  • Fixed an issue where publish-subscribe services with identical argument types produced non-compiling gRPC mapping code.

  • Fixed incorrect handling of component ordering when Deployment Types contained Component Groups.

12.1.3. Component Lifecycle

  • It is now possible to specify whether connection lifecycle methods are generated by setting connectionPhase="true" in the Implementation block of a Component Type.

12.2. Changes

12.2.1. Build Performance

  • Included built artefacts in Groundkit bundles instead of building from source during workspace builds.

12.2.2. Service Objects

  • Updated the representation of service objects and service object types.

12.3. Features

12.3.1. Logging

  • Added debug log output from Deployment and Component lifecycle phases.

12.4. Dependencies

  • Uses Tooling Core 2.0.2.

  • Uses GenOne Java 5.0.0.

13. HGK 3.0.0

13.1. Bug Fixes

13.1.1. Initialisation Data

  • Component instance initialisation data is now generated using the fully-qualified instance name.

  • The deployment folder was removed from the generated initialisation data path.

13.2. Breaking Changes

13.2.1. Modules

  • Removed the client module. Any gRPC service proxy initiators and service proxy targets must be regenerated.

13.3. Dependencies

  • Uses Tooling Core 2.0.0.