You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .squad/agents/docwriter/history.md
-34Lines changed: 0 additions & 34 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,22 +16,6 @@ Documentation authoring (2026-04-30 to 2026-05-17): 3-phase plan with 28 user-fa
16
16
17
17
<!-- Append new learnings below this line -->
18
18
19
-
### 2026-06-11: Air-Gapped Walkthroughs — GitHub Actions and Azure DevOps
20
-
21
-
**Context:** Authored two walkthrough documents for using apiops-cli in air-gapped (network-restricted) environments.
22
-
23
-
**Files Created:**
24
-
1.`docs/walkthrough/air-gapped-github-actions.md` — 8-step guide covering tarball preparation, `apiops init --cli-package`, lock file generation, npm cache transfer, self-hosted runner setup, workflow modifications for `npm ci --offline`, and upgrade procedures.
25
-
2.`docs/walkthrough/air-gapped-azure-devops.md` — 9-step guide with same core pattern plus Azure Artifacts feed as alternative to manual cache transfer, `npmAuthenticate@0` task usage, agent pool configuration, and AzureCLI@2 service connection authentication.
26
-
27
-
**Files Updated:**
28
-
-`docs/README.md` — Added walkthrough section to Quick Links table and directory tree.
29
-
30
-
**Learnings:**
31
-
- Air-gapped setups rely on `--cli-package` flag for local tarball mode, which generates `package.json` with `"file:.apiops/{tarball}"` dependency. The lock file is critical — without it, `npm ci` fails.
32
-
- Azure DevOps has a natural advantage for air-gapped setups via Azure Artifacts feeds with upstream sources (controlled sync windows). GitHub Actions environments must rely on pre-populated npm cache or vendored node_modules.
33
-
- Authentication differs: GitHub Actions in air-gapped may lose OIDC (can't reach token.actions.githubusercontent.com), requiring fallback to service principal secrets. Azure DevOps service connections work regardless since the agent-to-DevOps connectivity handles token exchange.
**Context:** Revised `docs/walkthrough/air-gapped-azure-devops.md` based on PR review comments.
138
-
139
-
**Changes:**
140
-
- Made local npm registry (Azure Artifacts) the primary/default approach; tarball flow demoted to fallback section.
141
-
- Removed redundant "npm 10+" prerequisite (implied by Node.js 22.x).
142
-
- Removed "transfer mechanism" prerequisite row (not needed when local registry is primary).
143
-
- Added official Microsoft docs links: self-hosted agents, Azure Artifacts npm feeds, Azure DevOps Server on-prem, sovereign cloud identity endpoints.
144
-
- Replaced full embedded pipeline YAML with concise edit table referencing generated files (`pipelines/run-extractor.yaml`, `pipelines/run-publisher.yaml`).
145
-
- Added "Sovereign Clouds and On-Premises" section with doc links.
146
-
- Simplified architecture diagram to reflect local registry flow.
147
-
148
-
**Learnings:**
149
-
- PR reviewers strongly prefer docs that match the air-gapped reality: local registries over manual transfers. Azure Artifacts is a natural fit since it's bundled with Azure DevOps Server.
150
-
- Large embedded YAML examples are fragile — they drift from generated templates. Better to describe minimal edits to the generated files.
151
-
- Always link to official Microsoft docs for infrastructure setup (agents, feeds, sovereign clouds) rather than inlining instructions that will go stale.
**What:** Created a new `docs/walkthrough/` directory for scenario-based step-by-step guides that are more detailed than the standard CI/CD integration docs. First entries cover air-gapped deployments for both GitHub Actions and Azure DevOps.
9
-
10
-
**Decision:** Establish walkthrough pattern for complex multi-step deployment scenarios that don't fit cleanly into standard integration guides.
11
-
12
-
**Pattern:**
13
-
-**`docs/walkthrough/`** = scenario-based, multi-step guides for specific deployment patterns
**Scope:** Future walkthrough candidates include multi-region APIM, sovereign cloud deployments, monorepo with multiple APIM instances. Any scenario requiring 5+ steps beyond the standard setup qualifies.
18
-
19
-
**Next Steps:** Team review; if approved, publish guides and update docs/README index.
20
-
21
-
---
22
-
23
5
### 2026-05-14T05:20:00Z: APIM v1 → v2 SKU Migration via apiops-cli
24
6
**By:** ApimExpert + ApiOpsLead (joint research and decision)
0 commit comments