Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

O3-3511: Content package to create zip file #1

Merged
merged 15 commits into from
Aug 15, 2024
Merged

O3-3511: Content package to create zip file #1

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
6bfbdf3
validates content.properties and creates a zip file
nravilla Jul 18, 2024
9e06b21
Changed conf directory structure
nravilla Jul 25, 2024
81aacee
Formatting and PR review changes
Aug 8, 2024
01e636a
Changes from PR review
Aug 12, 2024
02de783
Update pom.xml, Added validate-configurations
nravilla Aug 12, 2024
8e95a0f
Update pom.xml, added distributionManagement
nravilla Aug 13, 2024
aa83015
Added pluginRepospluginRepositories section
Aug 13, 2024
3d2a838
Changed sourceDir for validate-configurations
Aug 13, 2024
f1d883c
Update pom.xml, removed validate-configurations
nravilla Aug 14, 2024
7464118
Changed http to https
Aug 15, 2024
993a936
Updated urls
Aug 15, 2024
e52fb11
Added profiles to control execution
Aug 15, 2024
8002868
Update pom.xml, changed sourceFile to sourceDir
nravilla Aug 15, 2024
bb1d6eb
Added profiles to control execution
Aug 15, 2024
83e6df5
Formatting update
Aug 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions assembly.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.3"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.3
http://maven.apache.org/xsd/assembly-1.1.3.xsd">
<id>assemble-content</id>
<formats>
<format>zip</format>
</formats>
<includeBaseDirectory>false</includeBaseDirectory>
<fileSets>
<fileSet>
<directory>${project.basedir}</directory>
<includes>
<include>content.properties</include>
</includes>
</fileSet>
<fileSet>
<directory>${project.basedir}/configs</directory>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<directory>${project.basedir}/configs</directory>
<directory>${project.basedir}/configs</directory>

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is there a change suggested here?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removing whitespace

<includes>
<include>**/*</include>
</includes>
</fileSet>
</fileSets>
</assembly>
0 ...tion/ampathforms/ct_art_therapy_v1.0.json → ...nfig/ampathforms/ct_art_therapy_v1.0.json
View file
Open in desktop
File renamed without changes.
0 .../ampathforms/ct_cd4_lab_results_v1.0.json → .../ampathforms/ct_cd4_lab_results_v1.0.json
View file
Open in desktop
File renamed without changes.
0 ...n/ampathforms/ct_clinical_visit_v1.0.json → ...g/ampathforms/ct_clinical_visit_v1.0.json
View file
Open in desktop
File renamed without changes.
0 ...n/ampathforms/ct_clinical_visit_v2.0.json → ...g/ampathforms/ct_clinical_visit_v2.0.json
View file
Open in desktop
File renamed without changes.
0 .../ampathforms/ct_contact_tracing_v1.0.json → .../ampathforms/ct_contact_tracing_v1.0.json
View file
Open in desktop
File renamed without changes.
0 configuration/ampathforms/ct_death_v1.0.json → ...end_config/ampathforms/ct_death_v1.0.json
View file
Open in desktop
File renamed without changes.
0 ...on/ampathforms/ct_express_visit_v1.0.json → ...ig/ampathforms/ct_express_visit_v1.0.json
View file
Open in desktop
File renamed without changes.
0 ...ampathforms/ct_intimate_partner_v1.0.json → ...ampathforms/ct_intimate_partner_v1.0.json
View file
Open in desktop
File renamed without changes.
0 ...tion/ampathforms/ct_lab_results_v1.0.json → ...nfig/ampathforms/ct_lab_results_v1.0.json
View file
Open in desktop
File renamed without changes.
0 ...orms/ct_lab_specimen_collection_v1.0.json → ...orms/ct_lab_specimen_collection_v1.0.json
View file
Open in desktop
File renamed without changes.
0 ...on/ampathforms/ct_mental_health_v1.0.json → ...ig/ampathforms/ct_mental_health_v1.0.json
View file
Open in desktop
File renamed without changes.
0 ...thforms/ct_partner_notification_v1.0.json → ...thforms/ct_partner_notification_v1.0.json
View file
Open in desktop
File renamed without changes.
0 .../ampathforms/ct_patient_tracing_v1.0.json → .../ampathforms/ct_patient_tracing_v1.0.json
View file
Open in desktop
File renamed without changes.
0 .../ampathforms/ct_pead_disclosure_v1.0.json → .../ampathforms/ct_pead_disclosure_v1.0.json
View file
Open in desktop
File renamed without changes.
0 ...ampathforms/ct_service_delivery_v1.0.json → ...ampathforms/ct_service_delivery_v1.0.json
View file
Open in desktop
File renamed without changes.
0 ...mpathforms/ct_service_enrolment_v1.0.json → ...mpathforms/ct_service_enrolment_v1.0.json
View file
Open in desktop
File renamed without changes.
0 ...mpathforms/ct_service_enrolment_v1.1.json → ...mpathforms/ct_service_enrolment_v1.1.json
View file
Open in desktop
File renamed without changes.
0 ...ion/ampathforms/ct_transfer_out_v1.0.json → ...fig/ampathforms/ct_transfer_out_v1.0.json
View file
Open in desktop
File renamed without changes.
0 ...pathforms/ct_viral_load_request_v1.0.json → ...pathforms/ct_viral_load_request_v1.0.json
View file
Open in desktop
File renamed without changes.
0 ...pathforms/ct_viral_load_results_v1.0.json → ...pathforms/ct_viral_load_results_v1.0.json
View file
Open in desktop
File renamed without changes.
0 ...uration/conceptclasses/conceptclasses.csv → ..._config/conceptclasses/conceptclasses.csv
View file
Open in desktop
File renamed without changes.
0 ...uration/conceptsources/conceptsources.csv → ..._config/conceptsources/conceptsources.csv
View file
Open in desktop
File renamed without changes.
0 ...uration/encountertypes/encountertypes.csv → ..._config/encountertypes/encountertypes.csv
View file
Open in desktop
File renamed without changes.
0 ...p_OCT_v202310241547.2023-10-24_124407.zip → ...p_OCT_v202310241547.2023-10-24_124407.zip
View file
Open in desktop
File renamed without changes.
0 ...dentifiertypes/patientidentifiertypes.csv → ...dentifiertypes/patientidentifiertypes.csv
View file
Open in desktop
File renamed without changes.
0 configuration/programs/programs-hiv-ct.csv → ...ckend_config/programs/programs-hiv-ct.csv
View file
Open in desktop
File renamed without changes.
0 ...gramworkflows/programworkflows-hiv-ct.csv → ...gramworkflows/programworkflows-hiv-ct.csv
View file
Open in desktop
File renamed without changes.
0 ...owstates/programworkflowstates-hiv-ct.csv → ...owstates/programworkflowstates-hiv-ct.csv
View file
Open in desktop
File renamed without changes.
Empty file added configs/frontend_config/config.json
View file
Open in desktop
nravilla marked this conversation as resolved.
Show resolved Hide resolved
Empty file.
34 changes: 26 additions & 8 deletions content.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,26 @@
#name=Ref 3.x distro
#version=3.0.0
#war.openmrs=2.6.1-SNAPSHOT
omod.fhir2=1.9.0
omod.webservices.rest=2.40.0-SNAPSHOT
spa.frontendModules.@ohri/openmrs-esm-ohri-hiv-care-treatment-app=latest
spa.frontendModules.@ohri/openmrs-esm-ohri-core-app=latest
#spa.frontendModules.@openmrs/esm-primary-navigation-app=next
# content.properties - Metadata for the content package and its dependencies

# The name of this content package
name=openmrs-content-hiv
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
name=openmrs-content-hiv
name=hiv

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ideally, however, this would be populated from the POM directly:

Suggested change
name=openmrs-content-hiv
name=${project.artifactId}

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The above recommended change has been implemented, I don't know much about the data in content.properties, Amos will be responsible for the data. i just have name and version for the time being.


# The version of this content package (must follow SemVer)
version=1.0.0-SNAPSHOT

# Dependencies (specified in a format similar to distro.properties)

# OMOD modules with their SemVer range
omod.fhir2=1.0.0-SNAPSHOT
omod.reporting=^2.0.0

# SPA modules with their SemVer range
spa.frontendModules.@openmrs/esm-login-app=^3.0.0
spa.frontendModules.@openmrs/esm-patient-chart=^1.0.0
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Although this is good for demo purposes, I don't think we need this here.


# Additional dependencies can be listed here
# omod.another-module=^X.X.X
# spa.frontendModules.@openmrs/esm-another-app=^X.X.X

# Ensure to follow SemVer ranges when specifying versions
# For example:
# - ^1.0.0 means compatible with 1.0.0 including patch updates
# - ~1.2.3 means compatible with 1.2.x but not 1.3.0
nravilla marked this conversation as resolved.
Show resolved Hide resolved
91 changes: 84 additions & 7 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,86 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
<project
xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.openmrs</groupId>
<artifactId>openmrs-content-hiv</artifactId>
<version>1.0-SNAPSHOT</version>
<name>Archetype - openmrs-content-hiv</name>
<url>http://maven.apache.org</url>
<modelVersion>4.0.0</modelVersion>
<groupId>org.openmrs.content</groupId>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The formatting here is a little inconsistent using both spaces and tabs. Could we stick to one please?

<artifactId>openmrs-content-hiv</artifactId>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<artifactId>openmrs-content-hiv</artifactId>
<artifactId>hiv</artifactId>

<version>1.0-SNAPSHOT</version>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed:

Suggested change
<version>1.0-SNAPSHOT</version>
<version>1.0.0-SNAPSHOT</version>

<name>OpenMRS HIV Content Package</name>
<packaging>pom</packaging>
<developers>
<developer>
<name>OpenMRS</name>
<organization>OpenMRS</organization>
<organizationUrl>http://openmrs.org</organizationUrl>
</developer>
</developers>
<scm>
<connection>scm:git:git@github.com:openmrs/openmrs-content-hiv.git</connection>
<developerConnection>scm:git:git@github.com:openmrs/openmrs-content-hiv.git</developerConnection>
<url>https://github.com/openmrs/openmrs-content-hiv.git</url>
<tag>HEAD</tag>
</scm>
<dependencies>
<dependency>
ibacher marked this conversation as resolved.
Show resolved Hide resolved
<groupId>org.openmrs.maven.plugins</groupId>
<artifactId>openmrs-packager-maven-plugin</artifactId>
<version>1.8.0-SNAPSHOT</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.openmrs.maven.plugins</groupId>
<artifactId>openmrs-packager-maven-plugin</artifactId>
<version>1.8.0-SNAPSHOT</version>
<executions>
<execution>
<id>validate-assemble</id>
<phase>package</phase>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<phase>package</phase>
<phase>package</phase>

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also think this should probably be run in the verify phase rather than the package phase. Technically, that comes after the Zip is generated, but in production usage, we're doing to be running the deploy phase to publish this, and that will block that.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done! updated it to verify phase instead of package phase.

<configuration>
<sourceFile>{project.basedir}/content.properties</sourceFile>
</configuration>
<goals>
<goal>validate-assemble</goal>
</goals>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<goals>
<goal>validate-assemble</goal>
</goals>
<goals>
<goal>validate-assemble</goal>
</goals>

</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-assembly-plugin</artifactId>
<version>3.3.0</version>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should always use the latest version available, if possible.

Suggested change
<version>3.3.0</version>
<version>3.7.1</version>

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!

<executions>
<execution>
<id>make-assembly</id>
<phase>package</phase>
<goals>
<goal>single</goal>
</goals>
<configuration>
<descriptors>
<descriptor>${project.basedir}/assembly.xml</descriptor>
</descriptors>
<appendAssemblyId>false</appendAssemblyId>
<!-- Ensure this is set to false -->
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It'd likely be nice to have a why for this comment, but at least it should go with the right part.

Suggested change
<appendAssemblyId>false</appendAssemblyId>
<!-- Ensure this is set to false -->
<!-- Ensure this is set to false -->
<appendAssemblyId>false</appendAssemblyId>

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have added a comment, at the top instead of bottom.

<finalName>${project.artifactId}-${project.version}</finalName>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
<distributionManagement>
<repository>
<id>openmrs-repo-releases</id>
<name>OpenMRS Nexus Releases</name>
<url>https://mavenrepo.openmrs.org/nexus/content/repositories/releases</url>
</repository>
<snapshotRepository>
<id>openmrs-repo-snapshots</id>
<name>OpenMRS Nexus Snapshots</name>
<url>https://mavenrepo.openmrs.org/nexus/content/repositories/snapshots</url>
</snapshotRepository>
</distributionManagement>
</project>