diff --git a/README.md b/README.md index 277729d..56bf2c6 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,6 @@ # blank -Copier template for a part in any stack that has no template of its own, either as a `backend/` or `frontend/` part next to other parts or alone at the root of the project (`layout`). It brings nothing but the part contract, the code and the `Dockerfile` are yours. - -Ships `docker-compose.yml` with root-relative paths and one service under its own profile and `services`, `docker-compose.override.yml.example` (the `caddy` network alias, copied by `make env`), a `Makefile` with empty `fmt` and `check`, `build`, `pre-deploy` that rebuilds the image only when the part changed and an empty `post-deploy`, and `.env.example`. Applied on top of the `infra` template, `layout: parts` or `layout: single` respectively. The `caddy` template expects the backend to listen on 8080 and the frontend on 3000. +Copier template for a part with no template of its own: compose, Makefile and `.env.example`, the code and the `Dockerfile` are yours. A `backend/` or `frontend/` part or the whole project (`layout`), on top of `infra`. ```sh copier copy --trust -a .copier/backend.yml -d project_name="My Thing" -d part=backend diff --git a/template/{{ part_dir }}/Makefile.jinja b/template/{{ part_dir }}/Makefile.jinja index ed79bea..f3b5fd1 100644 --- a/template/{{ part_dir }}/Makefile.jinja +++ b/template/{{ part_dir }}/Makefile.jinja @@ -1,9 +1,6 @@ COMPOSE := {% if layout == 'part' %}cd .. && {% endif %}docker compose -IMAGE := {{ project_slug | replace('_', '-') }}/{{ part }} -changed = ! git diff --quiet $(1) -- $(2) 2>/dev/null -stamp = { git update-ref $(1) HEAD 2>/dev/null || true; } -.PHONY: {% if layout == 'root' %}env recreate rebuild restart logs down deploy {% endif %}fmt check build pre-deploy post-deploy +.PHONY: {% if layout == 'root' %}env recreate rebuild restart logs down {% endif %}fmt check build fmt: @: @@ -13,14 +10,6 @@ check: build: $(COMPOSE) build {{ service }} - -pre-deploy: - @if $(call changed,refs/deploy/{{ part }},.) || ! docker image inspect $(IMAGE) >/dev/null 2>&1; then \ - $(MAKE) build && $(call stamp,refs/deploy/{{ part }}); \ - fi - -post-deploy: - @: {% if layout == 'root' %} env: @fresh=; test -f .env || { cp .env.example .env; fresh=1; }; \ @@ -47,8 +36,4 @@ logs: down: $(COMPOSE) down - -deploy: pre-deploy - $(COMPOSE) up -d - $(MAKE) post-deploy {% endif %} \ No newline at end of file diff --git a/template/{{ part_dir }}/{% if layout == 'root' %}README.md{% endif %}.jinja b/template/{{ part_dir }}/{% if layout == 'root' %}README.md{% endif %}.jinja index 207217f..4f8bb41 100644 --- a/template/{{ part_dir }}/{% if layout == 'root' %}README.md{% endif %}.jinja +++ b/template/{{ part_dir }}/{% if layout == 'root' %}README.md{% endif %}.jinja @@ -1,14 +1,6 @@ # {{ project_name }} -Runs in Docker, locally the same way as in production. `COMPOSE_PROFILES` in `.env` selects the services that run on this machine. `docker-compose.override.yml` holds what differs between machines: published ports and the aliases on the external `caddy` network. - ```sh -make env -make recreate +make env # .env and docker-compose.override.yml from the examples +make recreate # the services in COMPOSE_PROFILES ``` - -`make env` creates `.env` and `docker-compose.override.yml` from their examples. `make recreate` starts the selected profiles, `make rebuild` builds the image first, `make logs`, `make restart` and `make down` do what they say. - -To deploy, `git pull && make deploy`. It runs `make pre-deploy`, which rebuilds the image only when something in the repository changed, then `docker compose up -d`. A deploy system with its own `up` step calls `make pre-deploy` before it and `make post-deploy` after. What was built is remembered as `refs/deploy/*` in the clone. - -In the fleet, production is deployed from `infra/komodo` instead (git mode of Komodo, see `docs/architecture.md` there): Komodo clones this repo, and a layer plus `deploy.sh` in the stack's directory tag images by the hash of what they bake in and write `.env` from sops. The repo only has to stay a plain recipe: images built from `build:` in compose, `caddy/site.caddy`. `make deploy` and `refs/deploy/*` are for a checkout deployed by hand.