Skip to content

Commit 9573071

Browse files
authored
Update README with info about testing and templating (#278)
1 parent edc9a05 commit 9573071

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,3 +123,22 @@ you:
123123
An example of this approach to develop with an ESP32 and the
124124
[esp-idf framework](https://github.com/espressif/esp-idf) is
125125
[here](provisioning/esp32/smart_desk/Makefile).
126+
127+
### Generate the templated files
128+
129+
To avoid duplications, a template generator produces files from templates.
130+
To generate templated files, do the following:
131+
132+
```sh
133+
scripts/generate-templated-files.sh
134+
```
135+
136+
After the generator produces the files, commit any updates to the generated files.
137+
138+
### Test cloud-init configurations
139+
140+
I use [cloud-init](https://cloudinit.readthedocs.io/) to perform some early provisioning
141+
and configuration tasks. It has a hard dependency on systemd, which may have issues
142+
running in containers. `scripts/test-cloud-init-configuration.sh` offers some support
143+
to run a containerized cloud-init instance, but it's currently too rough to
144+
integrate it in the CI/CD pipeline.

0 commit comments

Comments
 (0)