Skip to content

Commit 52b2955

Browse files
authored
Update README.md
1 parent 8245993 commit 52b2955

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

design/aws-build/README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,12 @@
1616

1717
### Build Integration Test Images
1818

19+
> [!NOTE]
20+
> Some Merritt Java Libraries and Services have integration tests as part of their code.
21+
> These integration tests run against mocked services that are implemented as docker images.
22+
> These Docker Images must be build first.
23+
24+
#### Build Trigger
1925
- Triggered by commit to merritt-docker
2026
- Triggered on demand
2127

@@ -56,6 +62,16 @@ graph TD
5662
---
5763

5864
### Java Libraries
65+
66+
> [!NOTE]
67+
> Merritt Java libraries are compiled and packaged as Jar files.
68+
> These Jar files are saved to AWS CodeArtifact.
69+
> Merritt libraries will always be written to CodeArtifact as a *maven snapshot* `-SNAPSHOT.jar`.
70+
> Snapshots can be over-written in CodeArtifact.
71+
> Going forward, the Merritt Team will bump up the snapshot version number for a jar file when making a breaking change to the JAR file.
72+
> The updated snapshot number will then need to be registered in the bom file.
73+
74+
#### Build Trigger
5975
- Triggered by commit to repo
6076
- Triggered on demand
6177

@@ -105,6 +121,21 @@ graph TD
105121
---
106122

107123
### Java Services (WAR)
124+
125+
> [!NOTE]
126+
> Merritt Java services are compiled and packaged as War files.
127+
> These Jar files are saved to AWS CodeArtifact.
128+
> Development artifacts may be written to CodeArtifact as a *maven snapshot* `-SNAPSHOT.war`.
129+
> Snapshots can be over-written in CodeArtifact.
130+
> Release candidates for an artifact must be generated with a unique semantic tag.
131+
> Artifacts with a semantic tag (non-snapshots) may not be over-written.
132+
> The Merritt code deployment process will pull WAR files from CodeArtifact.
133+
134+
#### Build Trigger
135+
- Triggered by commit to repo (snapshot update)
136+
- Triggered on demand (snapshot update)
137+
- Triggered by the tagging of a repo (semantically tagged artifact)
138+
108139
```mermaid
109140
graph TD
110141
subgraph GitHub

0 commit comments

Comments
 (0)