S19: establish engineering repository
This commit is contained in:
35
examples/README.md
Normal file
35
examples/README.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# Recipe example
|
||||
|
||||
`recipe-demo.json` describes the small example project. Its source is produced by
|
||||
the same templates as a new application; there is no application-specific pipeline.
|
||||
|
||||
From a released engineering checkout:
|
||||
|
||||
```sh
|
||||
python3 create-project.py recipe-demo examples/work/recipe-demo --version v1.0.0 --components both --runner engineering
|
||||
git -C examples/work/recipe-demo init -b main
|
||||
git -C examples/work/recipe-demo add .
|
||||
git -C examples/work/recipe-demo commit -m 'Generate recipe example'
|
||||
cd examples/work/recipe-demo
|
||||
java generated/ci/Ci.java verify
|
||||
```
|
||||
|
||||
Use the actual host runner label for your environment. The backend starter's
|
||||
`/hello` endpoint is a demonstration response used for recipe verification.
|
||||
Before adding or exposing business interfaces, apply the landscape's approved
|
||||
API decisions, including versioned JSON contracts, OpenAPI documentation, client
|
||||
generation and compatibility checks. This example does not introduce a business
|
||||
system or a cross-system data contract.
|
||||
|
||||
For a real isolated deployment test, run from engineering:
|
||||
|
||||
```sh
|
||||
python3 tests/acceptance.py examples/work/recipe-demo --registry registry.example:3000 --namespace owner --user owner --token-file /secure/path/package-token
|
||||
```
|
||||
|
||||
This creates uniquely named example images in the selected registry, starts a
|
||||
temporary local Compose project bound to loopback, deploys two synthetic
|
||||
revisions, then rolls back and checks both container revision labels. It removes
|
||||
the local test containers. Registry images remain as test evidence; they are not
|
||||
production images or releases. The deployment token needs package write/read
|
||||
access; it is supplied through stdin to Docker login, never committed.
|
||||
Reference in New Issue
Block a user