Updates to overlay standards used by scripts #696
l-monninger
started this conversation in
Ideas
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Summary
In order to facilitate better documentation of overlays and better namespacing, we propose two changes to the
just <application> <docker-compose|native> <overlays>
scripts:tests
which then contain individual overlays.Overlays in individual directories
Currently, the scripts look up application overlays as follows:
<application>
in a directory named<docker-compose|native>
which is at a well-known path from the repository root. That is,./well/known/path/<docker-compose|native>/<application>
.process-compose.yml
ordocker-compose.yml
that is found in the folder. That is, for example,./well/known/path/<docker-compose|native>/<application>/process-compose.yml
..
. Each overlay would correspond with a file containing its suffix. For example, theeth-local
process-compose overlay for the Suzuka Full Node would correspond to a file at./well/known/path/native/suzuka-full-node/process-compose.eth-local.yml
We propose a change to 3 above, that would instead place the
eth-local
file at./well/known/path/native/suzuka-full-node/eth-local/process-compose.yml
Pros:
./well/known/path/native/suzuka-full-node/eth-local/README.md
.Designated tests namespace
Currently, tests are written as common overlays. We propose instead a dedicated namespace with its own subdirectories be pulled out.
This would introduce a standard such that each application target would at least have the following structure:
In the case of the,
test-followers
test from Suzuka, this would be reorganized to:A special syntax can likewise be adopted to indicate when addressing this namespace, such as separating the feature string with a
:
. For example:This syntax could provide the basis for further namespace extensions in the future, though it may be better to restrict to just the tests versus standard overlays distinction.
Beta Was this translation helpful? Give feedback.
All reactions