Sylvain Duchesne
46 lines
2.5 KiB
YAML
46 lines
2.5 KiB
YAML
# Inter-repo contracts. `publish:` is this project's engagement toward its consumers —
|
|
# listing a leaf here IS the act of publishing it; an unlisted `contract_` leaf is a draft.
|
|
#
|
|
# This project is BOTH a provider and a consumer, and the two faces are isolated at document
|
|
# level: `indexing-layer` never mentions what we consume, and our `usage_` leaves never
|
|
# mention what we promise. What backs a published guarantee is internal doctrine.
|
|
#
|
|
# PROVIDES indexing-layer (concepts/indexing/indexing-layer/)
|
|
# consumer: the Festipod application, in its own repo. It has not declared a
|
|
# usage leaf, and we do not author one on its behalf — an interface with no
|
|
# declared consumer simply runs in the one-document mode.
|
|
#
|
|
# CONSUMES polyfill-surface and ng-e2e-helpers, both published by `ng-eventually-js`.
|
|
# We pull each engagement and author the `usage_ng-helpers.md` beside it.
|
|
#
|
|
# `pullFrom:` values are CANONICAL remote identities, because this file travels with the
|
|
# branch. Per-developer local access lives in `.project/contracts.local.yaml`, which is
|
|
# gitignored and must never be committed.
|
|
|
|
publish:
|
|
# paths are relative to `.project/`
|
|
#
|
|
# The engagement we OFFER, plus the two declarations we author as a CONSUMER. Listing a
|
|
# `usage_` leaf here is what lets each provider re-find it when it moves - and, more to
|
|
# the point, what makes it visible at all: a declaration nobody can discover leaves the
|
|
# provider with nothing but our source code to read.
|
|
#
|
|
# Both declarations are about this same repository, so the keys are qualified by the
|
|
# interface they speak on; publish keys must be unique.
|
|
indexing-layer: concepts/indexing/indexing-layer/contract_indexing-layer.md
|
|
polyfill-surface--ng-helpers: concepts/indexing/polyfill-surface/usage_ng-helpers.md
|
|
ng-e2e-helpers--ng-helpers: concepts/indexing/ng-e2e-helpers/usage_ng-helpers.md
|
|
|
|
consume:
|
|
- contract: polyfill-surface
|
|
type: git
|
|
pullFrom: git@gitea.reconnexion.apps.gueraud.net:Reconnexion/ng-eventually.git/.project/concepts/app-contract/polyfill-surface/contract_polyfill-surface.md
|
|
ref: caps-p1a-and-virtual-user-boundary
|
|
into: concepts/indexing/polyfill-surface/
|
|
|
|
- contract: ng-e2e-helpers
|
|
type: git
|
|
pullFrom: git@gitea.reconnexion.apps.gueraud.net:Reconnexion/ng-eventually.git/.project/concepts/e2e-harness/ng-e2e-helpers/contract_ng-e2e-helpers.md
|
|
ref: caps-p1a-and-virtual-user-boundary
|
|
into: concepts/indexing/ng-e2e-helpers/
|