S19: establish engineering repository
This commit is contained in:
20
templates/common/README.md
Normal file
20
templates/common/README.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# @PROJECT@
|
||||
|
||||
Generated from the version recorded in engineering.lock.json.
|
||||
Use JDK 25, Maven, Python 3, Git, Docker with Compose, and Node/npm for a frontend.
|
||||
Run `mvn verify` for a backend and `java generated/ci/Ci.java verify` for the full recipe.
|
||||
Local builds use committed generated files. Run
|
||||
`mvn -N -Pregenerate-engineering validate` to regenerate, or
|
||||
`python3 scripts/engineering.py --check` to check drift.
|
||||
|
||||
Edit engineering.properties for module paths, images (derived from PROJECT_NAME),
|
||||
deployment project, required secrets and dependencies. Edit deploy/health.sh for
|
||||
application readiness. Configure the workflow runner label and Gitea variables
|
||||
and secrets as described in the engineering README. Repository creation and
|
||||
secret installation are manual setup steps; the generator creates local files.
|
||||
|
||||
ADRs, specifications and onboarding: @LANDSCAPE@.
|
||||
Engineering usage and upgrades: @ENGINEERING@.
|
||||
Update engineering.lock.json's tag and commit together, regenerate and review
|
||||
the diff and that release's upgrade instructions. Project-owned files outside
|
||||
generated/ are never overwritten by an upgrade.
|
||||
Reference in New Issue
Block a user