Skip to content

MAINTAINERS.md

Latest commit

 

History

History
132 lines (77 loc) · 9.09 KB

MAINTAINERS.md

File metadata and controls

132 lines (77 loc) · 9.09 KB
Raw

Maintainer notes

Audience: people changing the build, dependency coordinates, tests, or WSDL layout - not library integrators. Integrators should use README.md, published Javadoc, and pom.xml coordinates.

Release lines

Version Java APIs Service stubs
1.6.3 8 javax.xml.ws, javax.xml.bind 14 (standard HI B2B)
1.6.5 11 Jakarta XML WS / Bind 14 (standard HI B2B)
1.7.0 11 Jakarta XML WS / Bind 26 (full MCA)

Git branch mapping (maintainers / checkout only — do not use in integrator docs):

Version Git branch
1.6.3 java-8-javax
1.6.5 java-11-jakarta
1.7.0 java-11-jakarta-full-wsdl

master is frozen and must stay in sync with origin/master — do not edit; use git worktree locally (CONTRIBUTING.md).

This checkout: 1.6.3-SNAPSHOT (1.6.3 release line).

Release scope (1.6.3)

  • Goal: Java 8 bytecode (maven.compiler.release 8) with javax.xml.ws / JAXB usage in application code; SOAP types au.net.electronichealth.* come from au.gov.nehta:hi-wsdl on the classpath ( hi.wsdl.version ). The default lifecycle does not run wsimport in this artifact.
  • wsdls/ is optional reference and Ant wsimport material (see wsdls/readme.txt), not required to compile this library.

Contributors vs release publisher (pom.xml)

Contributors (PRs, ordinary commits): Do not change <version> (stay on -SNAPSHOT unless the maintainer requests a bump), <scm><tag>, or distributionManagement. Leave maven-gpg-plugin skip true so default mvn verify does not require a signing key. Record user-visible work under CHANGELOG.md in the = <pom-version> = block that matches pom.xml <version>.

Release publisher: In the release change set: set <version> to the GA coordinate (no -SNAPSHOT); set <scm><tag> to the Git tag you will publish (match existing tag naming). Move CHANGELOG.md bullets from the snapshot section into a new = <GA-version> = section; add a fresh -SNAPSHOT block for the next development cycle. Deploy via Sonatype Central Portal (central-publishing-maven-plugin; copy settings.xml.example → settings.xml, server id central). See Release below.

Release

Publishing uses central-publishing-maven-plugin (Sonatype Central Portal). Copy settings.xml.example → settings.xml, server id central.

Parallel release lines (maintainers only): each Git branch publishes a different Maven version — integrators choose by coordinate, not branch name.

Branch Java HI client / WSDL version Facades
java-8-javax → master 8 / javax 1.6.3 14
java-11-jakarta 11 / Jakarta 1.6.5 14
java-11-jakarta-full-wsdl 11 / Jakarta 1.7.0 26

Release hi-wsdl and hi-b2b-client at the same GA version on the matching branch pair before integrators upgrade.

SNAPSHOT or manual GA

  1. Update CHANGELOG.md (and pom.xml / SCM <tag> for manual GA).
  2. mvn -B "-Prelease" clean verify
  3. mvn -B "-Prelease" deploy

Git/SCM settings for maven-release-plugin live in pom.xml properties (scm.repo.url, release.*). Tags default to {artifactId}-{version} (e.g. hi-b2b-client-1.7.0).

Automated GA (maven-release-plugin)

Run on the target branch with a clean working tree. The plugin commits version bumps, creates the release tag, deploys from the tag checkout, bumps to the next -SNAPSHOT, and pushes branch + tag (pushChanges / remoteTagging in pom.xml). Git remote credentials (SSH or HTTPS) must work non-interactively.

mvn -B "-Prelease" release:prepare release:perform -DreleaseVersion=1.7.0 -DdevelopmentVersion=1.7.1-SNAPSHOT -Dtag=hi-b2b-client-1.7.0

Replace versions and -Dtag for the branch you are on (hi-wsdl-1.6.5, hi-b2b-client-1.6.3, etc.). Omit -D… only if you accept interactive prompts.

After success: confirm the artifact on Central; repeat on the paired types/client repo. No extra Git steps unless push failed (then git push origin <branch> and git push origin <tag>).

-Dgpg.skip=false is equivalent to -Prelease for signing.

Changelog and releases

CHANGELOG.md uses = version = section headers. Match the snapshot header to pom.xml <version> until the publisher cuts GA.

Java / JAX stack (pom.xml properties)

  • maven.compiler.release 8 - bytecode and language level for Java 8 consumers.
  • ee4j.jaxws.version - com.sun.xml.ws:jaxws-rt on Maven Central (2.3.7 is the last 2.3.x for this branch). Transitive API JARs may use jakarta.* groupId coordinates while still exposing javax.* packages - do not exclude them from jaxws-rt in consumer POMs. This project only excludes webservices-rt from common-library (old stack conflict with jaxws-rt).
  • hi.wsdl.version — ${project.version} (same SNAPSHOT or GA as hi-b2b-client); mvn install in hi-wsdl-java before unpublished verify; coordinate GA releases with hi-wsdl-java.
  • nehta.lib.version - au.gov.nehta:common-library and explicit au.gov.nehta:smi-xsp ( smi-common-utils removed; ArgumentUtils and CertificateValidator come from smi-xsp / common-library transitives).

Fast builds

Defaults in pom.xml: maven-source-plugin jar-no-fork, maven-javadoc-plugin jar attach (maven-javadoc-plugin 3.12.0 has no jar-no-fork goal), verbose false, detectOfflineLinks false, maven-compiler-plugin proc none, maven-enforcer-plugin requireMavenVersion 3.6.3+, maven-clean-plugin retryOnError / force. JaCoCo is not bound to the default lifecycle; use -Pcoverage for prepare-agent and the verify report. Optional -Pdev-javadoc-off skips the Javadoc JAR for faster local verify. fat-jar shading drops duplicate ArgumentUtils from smi-xsp and WebServiceClientUtil / ArgumentUtils from common-library where this artifact provides its own copies.

Optional wsdls/ Ant + wsimport

Optional Ant targets under wsdls/build.xml need a directory of JAX-WS tool/runtime JARs (same coordinates as the root pom.xml). Populate wsdls/local-lib/ee4j-jaxws-from-maven/ from Central (gitignored) using wsdls/ee4j-jaxws-lib-pom.xml when present.

Keep ee4j.jaxws.version in wsdls/ee4j-jaxws-lib-pom.xml aligned with ee4j.jaxws.version in the repository root pom.xml.

hi-wsdl vs wsdls/

  • Generated SOAP types (au.net.electronichealth.*) come from au.gov.nehta:hi-wsdl at hi.wsdl.version. mvn compile does not require a populated wsdls/xml/wsdl tree.
  • wsdls/ holds WSDL/XSD material for reference, diffing, and optional codegen. Inventory and layout are described in wsdls/readme.txt.

Maven settings (settings.xml)

settings.xml.example (tracked) defines optional profile hi-wsdl-tree for parity with other branches. CI ( .github/workflows/ci.yml ) does not copy it to a project settings.xml; use plain mvn so contributor Maven user settings apply. Root build.* may pass -s only when MVN_SETTINGS is set.

Integration tests (-Pintegration)

The integration Maven profile widens Surefire to **/*Test.java and sets hi.require.live.config=true. Use with local.properties / HI_* when running mutual-TLS tests locally or in CI.

Cleaning target/

If mvn clean or codegen cannot delete target/ (locked files, read-only flags, antivirus, IDE indexers, or cloud-sync folders), close processes that hold the directory, then remove target/ manually.

Windows

From the repository root, clear read-only flags then delete the folder, for example:

attrib -R target /S /D

Then delete the target directory in File Explorer or with your shell.

macOS and Linux

From the repository root:

chmod -R u+w target && rm -rf target

Avoid relying on build trees inside folders that are continuously synced by desktop sync tools if deletes are flaky.

Facade surface vs WSDL inventory

Some binding WSDLs under wsdls/ may describe operations whose generated types are not present in a given hi-wsdl JAR. Those operations are not exposed as au.gov.nehta.vendorlibrary.hi.* clients until hi-wsdl (or an alternate codegen path) supplies the SEI types.

Copyright

Copyright 2011 NEHTA. Copyright 2021-2026 ADHA (Australian Digital Health Agency). Licensed under the Apache License, Version 2.0 - see LICENSE.md.