Commit 3c89529a authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

Merge branch 'docs/java-wrappers' into 'master' 

docs: add an admonition in usage and architecture guidelines on the use of wrapper tooling

Closes #39

See merge request to-be-continuous/doc!108
parents 771a504b f74b3e23

docs/dev/architecture.md

+11 −0
Original line number Diff line number Diff line
@@ -100,6 +100,17 @@ Why latest? 
- there is no _good default for everyone_: every project should select a specific version that fits their needs

- the latest version has more chances to be up-to-date with security patches (at least for an official and maintained project)



### Tool versions must be selected with image tags



Tools used in _to be continuous_ templates exist in many different versions, possibly not functionally equivalent to each other.

Think of Java, Python or even Kubectl: a given project shall use a specific version of those tools that fits exactly the project needs.



A project must select the required tool version by **selecting the appropriate image tag** (version), e.g., `registry-1.docker.io/library/maven:3.9-eclipse-temurin-17`.



As a corollary, _to be continuous_ should not support patterns or techniques abstracting the required tool version selection.

Ex: Maven Wrapper—although very convenient for the developer to automatically download and use the required Maven version—shall not

be supported by _to be continuous_, that will instead expect the right Java + Maven versions to be specified via the image tag.



## Test alongside build



For built languages, we've decided that build and test should stand in the same GitLab job (at least by default).