Skip to content

Commit

Permalink
Merge pull request #20 from UCLH-DHCT/jeremy/misc-fixes
Browse files Browse the repository at this point in the history
Mostly docs fixes. Set java version in all poms.
  • Loading branch information
jeremyestein authored Jun 14, 2024
2 parents bd49672 + 8a8c3d5 commit 04bd6cc
Show file tree
Hide file tree
Showing 6 changed files with 34 additions and 3 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,19 @@ EMAP [your root emap directory]

## Developer onboarding

- How to [configure IntelliJ](docs/intellij.md) to build emap and run tests.
- How to [configure IntelliJ](docs/dev/intellij.md) to build emap and run tests.
- [Onboarding](docs/dev/onboarding.md) gives details on how data items are processed and the test strategies used.


# Monorepo migration

How were [old repos migrated into this repo?](docs/migration.md)
How were [old repos migrated into this repo?](docs/dev/migration.md)


# Branching strategy

`main` should always be usable in production, having gone through a validation run as well as the "standard" checks
of code review and GHA tests using synthetic data.

The `develop` branch is a pre-release branch intended to bring together one or more PRs. The standard checks
are performed when merging into here, but we can delay the full validation run until we're ready to merge to `main`.
1 change: 1 addition & 0 deletions docs/dev/core.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,3 +156,4 @@ manages the multiple repositories and configuration files.

Ports which are allocated per project are listed on the [GAE port log](https://liveuclac.sharepoint.com/sites/RITS-EMAP/_layouts/OneNote.aspx?id=%2Fsites%2FRITS-EMAP%2FSiteAssets%2FInform%20-%20Emap%20Notebook&wd=target%28_Collaboration%20Space%2FOrganisation%20Notes.one%7C3BDBA82E-CB01-45FF-B073-479542EA6D7E%2FGAE%20Port%20Log%7C1C87DFDC-7FCF-4B63-BC51-2BA497BA8DBF%2F%29)

Reserve an Emap DB schema on the GAE using the [load times spreadsheet](https://liveuclac.sharepoint.com/:x:/r/sites/RITS-EMAP-EmapDevChatter/Shared%20Documents/Emap%20Dev%20Chatter/load_times.xlsx?d=w20bdbe908b0f4e309caeb62590e890a0&csf=1&web=1&e=ZiUVZB):
File renamed without changes
15 changes: 14 additions & 1 deletion docs/dev/intellij.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,12 +76,25 @@ These setup instructions are aimed at developing in [IntelliJ IDEA](https://www.
</details>

7. <details>
<summary>Point to correct Java versions</summary>

There are several places in IntelliJ that relate to the java version used.
These settings are sometimes correctly set from the maven config but you may want to double check in case of errors.
`Project Structure | Project Settings | Project` (SDK to use and default language level)
`Project Structure | Project Settings | Modules` (per module language levels)
`Preferences | Build, Execution, Deployment | Compiler | Java Compiler` (Project bytecode version and per-module bytecode version)
`Preferences | Build, Execution, Deployment | Build Tools | Maven | Importing` (JDK for importer)

At the time of writing, hoover uses java 11 and all other modules use java 17.
</details>

8. <details>
<summary>Add lombok and checkstyle plugins</summary>

Go to <b>File > Settings > search for plugins</b>, search lombok and checkstyle and install them
</details>

8. <details>
9. <details>
<summary>Setup checkstyle</summary>

To allow checkstyle to be run go to <b>File > settings > search for checkstyle</b>
Expand Down
2 changes: 2 additions & 0 deletions emap-interchange/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,8 @@
<artifactId>maven-compiler-plugin</artifactId>
<version>${maven-compiler-plugin.version}</version>
<configuration>
<source>${java.version}</source>
<target>${java.version}</target>
<forceJavacCompilerUse>true</forceJavacCompilerUse>
</configuration>
</plugin>
Expand Down
6 changes: 6 additions & 0 deletions emap-star/emap-star-annotations/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
</parent>

<properties>
<java.version>17</java.version>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<auto-service.version>1.0.1</auto-service.version>
</properties>
Expand All @@ -39,6 +40,11 @@
<!-- Needed for annotation processing -->
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<source>${java.version}</source>
<target>${java.version}</target>
<forceJavacCompilerUse>true</forceJavacCompilerUse>
</configuration>
<executions>
<execution>
<id>default-compile</id>
Expand Down

0 comments on commit 04bd6cc

Please sign in to comment.