From 4d8ad6304b568f88165cf5c09732b2539eec27a1 Mon Sep 17 00:00:00 2001 From: Petri Vuorio <21276470+petringo@users.noreply.github.com> Date: Wed, 10 Aug 2022 07:50:42 +0300 Subject: [PATCH 1/3] Use fmi-avi-messageconverter-bom to manage library versions. --- CHANGELOG.md | 2 +- README.md | 2 +- pom.xml | 120 +++++++++++++++++++++++++++++++++++++++++----- src/doc/README.md | 18 +++---- 4 files changed, 118 insertions(+), 24 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c6132d6..0a7daa7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,7 +13,7 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ### Changed -- ... +- Use fmi-avi-messageconverter-bom to manage library versions ### Deprecated diff --git a/README.md b/README.md index 72a8364..e54dd4c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Aviation Message Archiver diff --git a/pom.xml b/pom.xml index 97fcc90..18b5be2 100644 --- a/pom.xml +++ b/pom.xml @@ -1,5 +1,6 @@ - + 4.0.0 fi.fmi @@ -61,11 +62,10 @@ 2.6.3 1.9 31.0.1-jre - 6.1.0 - 5.1.0 - 4.1.0 1.0.0 + avidb-schema-${avidb-schema.version} + bundle all,-missing @@ -82,6 +82,13 @@ pom import + + fi.fmi.avi.converter + fmi-avi-messageconverter-bom + 1.1.0 + pom + import + @@ -141,17 +148,14 @@ fi.fmi.avi.converter fmi-avi-messageconverter - ${fmi-avi-messageconverter.version} fi.fmi.avi.converter fmi-avi-messageconverter-tac - ${fmi-avi-messageconverter-tac.version} fi.fmi.avi.converter fmi-avi-messageconverter-iwxxm - ${fmi-avi-messageconverter-iwxxm.version} fi.fmi.avi.avidb @@ -248,6 +252,100 @@ + + org.apache.maven.plugins + maven-dependency-plugin + 3.3.0 + + + dependency-properties + validate + + properties + + + + + + + org.codehaus.mojo + build-helper-maven-plugin + 3.3.0 + + + build-helper-regex-artifact-branch-rawnames + validate + + regex-properties + + + + + fmi-avi-messageconverter.branch-rawname + ${fi.fmi.avi.converter:fmi-avi-messageconverter:jar} + ^.*/(fmi-avi-messageconverter-[0-9\.]+(-SNAPSHOT)?)\.jar.*$ + $1 + true + + + fmi-avi-messageconverter-iwxxm.branch-rawname + ${fi.fmi.avi.converter:fmi-avi-messageconverter-iwxxm:jar} + ^.*/(fmi-avi-messageconverter-iwxxm-[0-9\.]+(-SNAPSHOT)?)\.jar.*$ + $1 + true + + + fmi-avi-messageconverter-tac.branch-rawname + ${fi.fmi.avi.converter:fmi-avi-messageconverter-tac:jar} + ^.*/(fmi-avi-messageconverter-tac-[0-9\.]+(-SNAPSHOT)?)\.jar.*$ + $1 + true + + + + + + build-helper-regex-artifact-branch-names + validate + + regex-properties + + + + + fmi-avi-messageconverter.branch-name + ${fmi-avi-messageconverter.branch-rawname} + ^.*-SNAPSHOT$ + main + false + + + fmi-avi-messageconverter-iwxxm.branch-name + ${fmi-avi-messageconverter-iwxxm.branch-rawname} + ^.*-SNAPSHOT$ + main + false + + + fmi-avi-messageconverter-tac.branch-name + ${fmi-avi-messageconverter-tac.branch-rawname} + ^.*-SNAPSHOT$ + main + false + + + avidb-schema.branch-name + ${avidb-schema.branch-rawname} + ^.*-SNAPSHOT$ + main + false + + + + + + + org.apache.maven.plugins maven-release-plugin @@ -257,8 +355,8 @@ Generate documentation and include it in SCM. Requires plugin version >=3. https://stackoverflow.com/a/68687685 --> - resources:copy-resources@readme scm:add -Dincludes=README.md - resources:copy-resources@readme scm:add -Dincludes=README.md + validate resources:copy-resources@readme scm:add -Dincludes=README.md + validate resources:copy-resources@readme scm:add -Dincludes=README.md @@ -279,10 +377,6 @@ - - org.codehaus.mojo - build-helper-maven-plugin - diff --git a/src/doc/README.md b/src/doc/README.md index df2f651..36302b2 100644 --- a/src/doc/README.md +++ b/src/doc/README.md @@ -1,7 +1,7 @@ # Aviation Message Archiver @@ -85,11 +85,11 @@ Supported message types and formats are listed in the table below. Generally, th * TAC format message types that are supported by [fmi-avi-messageconverter-tac](https://github.com/fmidev/fmi-avi-messageconverter-tac) - library [`TAC_TO_GENERIC_AVIATION_WEATHER_MESSAGE_POJO`](https://github.com/fmidev/fmi-avi-messageconverter-tac/blob/fmi-avi-messageconverter-tac-${fmi-avi-messageconverter-tac.version}/src/main/java/fi/fmi/avi/converter/tac/conf/TACConverter.java) + library [`TAC_TO_GENERIC_AVIATION_WEATHER_MESSAGE_POJO`](https://github.com/fmidev/fmi-avi-messageconverter-tac/blob/${fmi-avi-messageconverter-tac.branch-name}/src/main/java/fi/fmi/avi/converter/tac/conf/TACConverter.java) conversion and * IWXXM format message types that are supported by [fmi-avi-messageconverter-iwxxm](https://github.com/fmidev/fmi-avi-messageconverter-iwxxm) - library [`IWXXM_STRING_TO_GENERIC_AVIATION_WEATHER_MESSAGE_POJO`](https://github.com/fmidev/fmi-avi-messageconverter-iwxxm/blob/fmi-avi-messageconverter-iwxxm-${fmi-avi-messageconverter-iwxxm.version}/src/main/java/fi/fmi/avi/converter/iwxxm/conf/IWXXMConverter.java) + library [`IWXXM_STRING_TO_GENERIC_AVIATION_WEATHER_MESSAGE_POJO`](https://github.com/fmidev/fmi-avi-messageconverter-iwxxm/blob/${fmi-avi-messageconverter-iwxxm.branch-name}/src/main/java/fi/fmi/avi/converter/iwxxm/conf/IWXXMConverter.java) conversion. | Message type | TAC | IWXXM 2.1 | IWXXM 3.0 | @@ -138,11 +138,11 @@ using H2 (in-memory) or PostGIS database engine. 3. Prepare an SQL script to populate the `avidb_stations` table. This is optional for testing the application, but all messages will be rejected without a matching location indicator in the `icao` column of `avidb_stations` table. * **H2:** - See [schema-h2.sql](https://github.com/fmidev/avidb-schema/blob/avidb-schema-${avidb-schema.version}/h2/schema-h2.sql) + See [schema-h2.sql](https://github.com/fmidev/avidb-schema/blob/${avidb-schema.branch-name}/h2/schema-h2.sql) for the schema, and [h2-data/example/avidb_stations.sql](src/main/resources/h2-data/example/avidb_stations.sql) for an insertion template. * **PostGIS:** - See [schema-postgresql.sql](https://github.com/fmidev/avidb-schema/blob/avidb-schema-${avidb-schema.version}/postgresql/schema-postgresql.sql) + See [schema-postgresql.sql](https://github.com/fmidev/avidb-schema/blob/${avidb-schema.branch-name}/postgresql/schema-postgresql.sql) for the schema, and [postgresql-data/example/avidb_stations.sql](src/main/resources/postgresql-data/example/avidb_stations.sql) for an insertion template. @@ -486,7 +486,7 @@ Populate properties parsed from message content. order of preference for reading the station ICAO code. Available message types are specified in the map property `production-line.type-ids`. Available location indicator types are specified - in [GenericAviationWeatherMessage.LocationIndicatorType](https://github.com/fmidev/fmi-avi-messageconverter/blob/fmi-avi-messageconverter-${fmi-avi-messageconverter.version}/src/main/java/fi/fmi/avi/model/GenericAviationWeatherMessage.java) + in [GenericAviationWeatherMessage.LocationIndicatorType](https://github.com/fmidev/fmi-avi-messageconverter/blob/${fmi-avi-messageconverter.branch-name}/src/main/java/fi/fmi/avi/model/GenericAviationWeatherMessage.java) enum. Example: ```yaml @@ -508,7 +508,7 @@ Populate properties parsed from message content. * `default-location-indicator-types` (optional) - Default list of location indicator types in order of preference for reading the station ICAO code. Only used when the message type-specific list is not configured. Available location indicator types are specified - in [GenericAviationWeatherMessage.LocationIndicatorType](https://github.com/fmidev/fmi-avi-messageconverter/blob/fmi-avi-messageconverter-${fmi-avi-messageconverter.version}/src/main/java/fi/fmi/avi/model/GenericAviationWeatherMessage.java) + in [GenericAviationWeatherMessage.LocationIndicatorType](https://github.com/fmidev/fmi-avi-messageconverter/blob/${fmi-avi-messageconverter.branch-name}/src/main/java/fi/fmi/avi/model/GenericAviationWeatherMessage.java) enum. Example: ```yaml @@ -758,10 +758,10 @@ The following mappings must exist under `production-line` application configurat * `route-ids`: Map route name, preferably same as database column `avidb_message_routes.name`, to database column `avidb_message_routes.route_id`. * `format-ids`: - Map [`GenericAviationWeatherMessage.Format.name()`](https://github.com/fmidev/fmi-avi-messageconverter/blob/fmi-avi-messageconverter-${fmi-avi-messageconverter.version}/src/main/java/fi/fmi/avi/model/GenericAviationWeatherMessage.java) + Map [`GenericAviationWeatherMessage.Format.name()`](https://github.com/fmidev/fmi-avi-messageconverter/blob/${fmi-avi-messageconverter.branch-name}/src/main/java/fi/fmi/avi/model/GenericAviationWeatherMessage.java) to database column `avidb_message_format.format_id`. * `type-ids`: - Map [`MessageType.name()`](https://github.com/fmidev/fmi-avi-messageconverter/blob/fmi-avi-messageconverter-${fmi-avi-messageconverter.version}/src/main/java/fi/fmi/avi/model/MessageType.java) + Map [`MessageType.name()`](https://github.com/fmidev/fmi-avi-messageconverter/blob/${fmi-avi-messageconverter.branch-name}/src/main/java/fi/fmi/avi/model/MessageType.java) to database column `avidb_message_types.type_id`. See the provided [application.yml] for an example. From de69f342bdbb5abff3f2c880e2fac8338c37a2e4 Mon Sep 17 00:00:00 2001 From: Petri Vuorio <21276470+petringo@users.noreply.github.com> Date: Wed, 10 Aug 2022 10:00:14 +0300 Subject: [PATCH 2/3] Add pull request link to CHANGELOG.md. --- CHANGELOG.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0a7daa7..1743a7a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,7 +13,7 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ### Changed -- Use fmi-avi-messageconverter-bom to manage library versions +- Use fmi-avi-messageconverter-bom to manage library versions [#119] ### Deprecated @@ -46,3 +46,5 @@ Initial release. [v1.0.1]: https://github.com/fmidev/aviation-message-archiver/releases/tag/aviation-message-archiver-1.0.1 [v1.0.0]: https://github.com/fmidev/aviation-message-archiver/releases/tag/aviation-message-archiver-1.0.0 + +[#119]: https://github.com/fmidev/aviation-message-archiver/pull/119 From f653de89458209531b8bf2cf9255e526d800f22c Mon Sep 17 00:00:00 2001 From: Petri Vuorio <21276470+petringo@users.noreply.github.com> Date: Tue, 13 Sep 2022 15:09:45 +0300 Subject: [PATCH 3/3] Regenerate README.md. --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index e54dd4c..9f96dee 100644 --- a/README.md +++ b/README.md @@ -160,7 +160,7 @@ using H2 (in-memory) or PostGIS database engine. ``` 5. Check - some [actuator endpoints](https://docs.spring.io/spring-boot/docs/2.6.3/reference/html/actuator.html#actuator.endpoints) + some [actuator endpoints](https://docs.spring.io/spring-boot/docs/2.7.2/reference/html/actuator.html#actuator.endpoints) to see that the application is running and healthy. * info: * health: @@ -284,11 +284,11 @@ Application configuration properties are collected in a YAML file called [applic file is a base configuration, acting as an example. You can use it as a base for your own application configuration file. In your custom configuration file you need to add and/or override only changed or forced properties in your own configuration file, because the provided base configuration file is loaded as well. -See [External Application Properties](https://docs.spring.io/spring-boot/docs/2.6.3/reference/html/features.html#features.external-config.files) +See [External Application Properties](https://docs.spring.io/spring-boot/docs/2.7.2/reference/html/features.html#features.external-config.files) in Spring Boot reference documentation for instructions on how to apply your custom configuration file. Runtime behavior is controlled -using [Spring profiles](https://docs.spring.io/spring-boot/docs/2.6.3/reference/html/features.html#features.profiles) +using [Spring profiles](https://docs.spring.io/spring-boot/docs/2.7.2/reference/html/features.html#features.profiles) which are activated by the application launch command. Profiles declared in the provided configuration are described in the [application.yml] file. @@ -769,17 +769,17 @@ See the provided [application.yml] for an example. ### Spring Boot configuration properties Many of the properties in [application.yml] configuration file control the behavior of Spring Boot features. Look at -the [Spring Boot Reference Documentation](https://docs.spring.io/spring-boot/docs/2.6.3/reference/html/) +the [Spring Boot Reference Documentation](https://docs.spring.io/spring-boot/docs/2.7.2/reference/html/) for more information on these. Some of related sections are: -* [Profiles](https://docs.spring.io/spring-boot/docs/2.6.3/reference/html/features.html#features.profiles) -* [Logging](https://docs.spring.io/spring-boot/docs/2.6.3/reference/html/features.html#features.logging) -* [Data](https://docs.spring.io/spring-boot/docs/2.6.3/reference/html/data.html) - * [Data Properties](https://docs.spring.io/spring-boot/docs/2.6.3/reference/html/application-properties.html#appendix.application-properties.data) - * [Data Migration Properties](https://docs.spring.io/spring-boot/docs/2.6.3/reference/html/application-properties.html#appendix.application-properties.data-migration) -* [Graceful Shutdown](https://docs.spring.io/spring-boot/docs/2.6.3/reference/html/web.html#web.graceful-shutdown) - * [Timeout property](https://docs.spring.io/spring-boot/docs/2.6.3/reference/html/application-properties.html#application-properties.core.spring.lifecycle.timeout-per-shutdown-phase) -* [Actuator Endpoints](https://docs.spring.io/spring-boot/docs/2.6.3/reference/html/actuator.html#actuator.endpoints) +* [Profiles](https://docs.spring.io/spring-boot/docs/2.7.2/reference/html/features.html#features.profiles) +* [Logging](https://docs.spring.io/spring-boot/docs/2.7.2/reference/html/features.html#features.logging) +* [Data](https://docs.spring.io/spring-boot/docs/2.7.2/reference/html/data.html) + * [Data Properties](https://docs.spring.io/spring-boot/docs/2.7.2/reference/html/application-properties.html#appendix.application-properties.data) + * [Data Migration Properties](https://docs.spring.io/spring-boot/docs/2.7.2/reference/html/application-properties.html#appendix.application-properties.data-migration) +* [Graceful Shutdown](https://docs.spring.io/spring-boot/docs/2.7.2/reference/html/web.html#web.graceful-shutdown) + * [Timeout property](https://docs.spring.io/spring-boot/docs/2.7.2/reference/html/application-properties.html#application-properties.core.spring.lifecycle.timeout-per-shutdown-phase) +* [Actuator Endpoints](https://docs.spring.io/spring-boot/docs/2.7.2/reference/html/actuator.html#actuator.endpoints) ## License