Skip to content

Commit e76fcf8

Browse files
Frame deployment designs as "Deploying <service provider> from <CI/CD platform>"
Rename the design to "Deploying Azure from GitHub" and adopt the service provider / CI/CD platform vocabulary across the deployment spec, index, and design so the two axes of each combination are unambiguous; rename the design file to azure-from-github.md to match. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 parent 63b6803 commit e76fcf8

5 files changed

Lines changed: 24 additions & 20 deletions

File tree

src/docs/Capabilities/deployment/designs/github-azure.md renamed to src/docs/Capabilities/deployment/designs/azure-from-github.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
11
---
2-
title: GitHub + Azure design
3-
description: How the deployment spec is delivered with GitHub as the deployment platform and Azure as the service provider, using Terraform to compute and apply the approved effect.
2+
title: Deploying Azure from GitHub
3+
description: How the deployment spec is delivered with Azure as the service provider and GitHub as the CI/CD platform, using Terraform to compute and apply the approved effect.
44
---
55

6-
# Deployment — GitHub + Azure design
6+
# Deploying Azure from GitHub
77

88
This design delivers the [Deployment spec](../spec.md) for one combination:
9-
**GitHub** as the deployment platform and **Azure** (including Microsoft Entra
10-
ID) as the service provider, with **Terraform (open source)** as the change
9+
**Azure** (including Microsoft Entra ID) as the service provider and **GitHub**
10+
as the CI/CD platform, with **Terraform (open source)** as the change
1111
engine. The computed effect the spec speaks of is a **saved Terraform plan**;
1212
the record of state is a remote Terraform state per environment.
1313

14-
Another design covers another combination — Azure DevOps with Azure, GitHub with
15-
AWS, GitHub with GitHub — without changing the spec.
14+
Another design covers another combination — deploying Azure from Azure DevOps,
15+
deploying AWS from GitHub, deploying GitHub from GitHub — without changing the
16+
spec.
1617

1718
## Approach
1819

@@ -166,7 +167,7 @@ on:
166167
```
167168
168169
The core is provider-agnostic; the Azure sign-in is the single service-provider
169-
step. A different service provider (AWS) or deployment platform (Azure DevOps)
170+
step. A different service provider (AWS) or CI/CD platform (Azure DevOps)
170171
reuses this design's shape with its own identity step and is documented as its
171172
own design under [Deployment](../index.md).
172173
Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Deployment
3-
description: How a change to managed resources is approved together with its effect and deployed exactly as approved — one spec, one design per deployment platform and service provider.
3+
description: How a change to managed resources is approved together with its effect and deployed exactly as approved — one spec, and one design for each combination of deploying a service provider from a CI/CD platform.
44
---
55

66
# Deployment
@@ -11,10 +11,13 @@ change together with that effect across every environment it will pass through,
1111
and the approved effect is exactly what is deployed — with every action recorded.
1212

1313
The **spec** is the durable contract and is deliberately free of any technology.
14-
Each **design** delivers that contract for one combination of **deployment
15-
platform** and **service provider** (for example GitHub with Azure, Azure DevOps
16-
with Azure, GitHub with AWS, or GitHub with GitHub). Adding a combination adds a
17-
design; it never changes the spec.
14+
Each **design** delivers that contract for one combination, named **"deploying
15+
&lt;service provider&gt; from &lt;CI/CD platform&gt;"** so the two parts are
16+
clear: the **service provider** is where the resources live (Azure, AWS,
17+
GitHub), and the **CI/CD platform** is what runs the deployment (GitHub, Azure
18+
DevOps) — for example deploying Azure from GitHub, deploying Azure from Azure
19+
DevOps, deploying AWS from GitHub, or deploying GitHub from GitHub. Adding a
20+
combination adds a design; it never changes the spec.
1821

1922
## Spec
2023

@@ -24,6 +27,6 @@ design; it never changes the spec.
2427

2528
## Designs
2629

27-
| Design | Deployment platform | Service provider | Description |
30+
| Design | Service provider | CI/CD platform | Description |
2831
| --- | --- | --- | --- |
29-
| [GitHub + Azure](designs/github-azure.md) | GitHub | Azure | GitHub Actions and Terraform deploy Azure and Entra resources with passwordless identity, approving the code change together with its per-environment effect. |
32+
| [Deploying Azure from GitHub](designs/azure-from-github.md) | Azure | GitHub | GitHub Actions and Terraform deploy Azure and Entra resources with passwordless identity, approving the code change together with its per-environment effect. |

src/docs/Capabilities/deployment/spec.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ of deployments whose deployed effect equals their approved effect (target 100%).
6060

6161
Out of scope:
6262

63-
- The choice of deployment platform, service provider, and change engine — each
63+
- The choice of CI/CD platform, service provider, and change engine — each
6464
combination is a **[design](index.md)**, not part of this contract.
6565
- Application or runtime release — this capability governs managed resources.
6666
- Provisioning of the state, identity, and trust the deployment relies on, which
@@ -220,13 +220,13 @@ Feature: Deployment approves and applies the effect, not just the code
220220
effect.
221221
- A **record of state** for each environment exists, against which an effect is
222222
computed and whose change can invalidate a previously approved effect.
223-
- The specifics of **how** — the deployment platform, the service provider, the
223+
- The specifics of **how** — the CI/CD platform, the service provider, the
224224
change engine, and the identity mechanism — are supplied by a
225225
[design](index.md), not this spec.
226226

227227
## Where this connects
228228

229229
- [Designs](index.md) — how these requirements are delivered for a specific
230-
deployment platform and service provider.
230+
service provider and CI/CD platform.
231231
- [Documentation Model](../../Ways-of-Working/Documentation-Model.md) — why this spec holds only the why and the what.
232232
- [PR Format](../../Ways-of-Working/PR-Format.md) — the review that approves the change and its effect.

src/docs/Capabilities/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ the same spec-and-design shape as any other capability; the standalone
2525
| [Dependency Updates](dependency-updates/index.md) | How a repository's pinned dependencies are kept current and secure through automated, labelled update pull requests. |
2626
| [Merge Automation](merge-automation/index.md) | How a pull request's required status checks become the machine-readable signal that drives automated approval and merge — green merges, red holds, nothing bypasses the gate. |
2727
| [Downstream Release Propagation](downstream-release-propagation/index.md) | How a release in one repository propagates to the repositories that depend on it, via a delegated agent pull request. |
28-
| [Deployment](deployment/index.md) | How a change to managed resources is approved together with its effect and deployed exactly as approved — one spec, one design per deployment platform and service provider. |
28+
| [Deployment](deployment/index.md) | How a change to managed resources is approved together with its effect and deployed exactly as approved — one spec, and one design for each combination of deploying a service provider from a CI/CD platform. |
2929
| [VS Code Extension Framework](vscode-extension-framework/index.md) | How a VS Code extension is built, tested, versioned, packaged, and published — one GitHub-native pipeline, opt-in from a template and a single settings file. |
3030
| [PowerShell on GitHub](powershell-on-github/index.md) | How we make GitHub a first-class platform for PowerShell through reusable modules, actions, and capability gaps we close over time. |
3131

src/zensical.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ nav = [
136136
{"Deployment" = [
137137
"Capabilities/deployment/index.md",
138138
{"Spec" = "Capabilities/deployment/spec.md"},
139-
{"GitHub + Azure design" = "Capabilities/deployment/designs/github-azure.md"},
139+
{"Deploying Azure from GitHub" = "Capabilities/deployment/designs/azure-from-github.md"},
140140
]},
141141
{"VS Code Extension Framework" = [
142142
"Capabilities/vscode-extension-framework/index.md",

0 commit comments

Comments
 (0)