Skip to content

Commit cbe134f

Browse files
CopilotEMaher
andauthored
docs: add air-gapped apiops setup walkthroughs for GitHub Actions and Azure DevOps (#77)
* docs: add air-gapped environment walkthroughs for GitHub Actions and Azure DevOps Add step-by-step guides under docs/walkthrough/ covering: - Tarball preparation with --cli-package flag - Lock file strategy for offline npm ci - Self-hosted runner/agent configuration - Workflow/pipeline modifications for offline operation - Upgrade procedures and troubleshooting Update docs/README.md navigation with new walkthrough section. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: EMaher <9244742+EMaher@users.noreply.github.com> * docs: merge decision on air-gapped walkthrough documentation pattern - Merged inbox/docwriter-airgapped-walkthroughs.md into decisions.md - Established walkthrough pattern for complex multi-step deployment scenarios - Covers GitHub Actions and Azure DevOps air-gapped deployments - Pattern: docs/walkthrough/ (scenario-based), docs/ci-cd/ (reference), docs/guides/ (feature-oriented) - Deleted merged inbox file Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: EMaher <9244742+EMaher@users.noreply.github.com> * chore: record squad orchestration logs for air-gapped walkthrough task Agent-Logs-Url: https://github.com/Azure/apiops-cli/sessions/55ca6c66-0c45-4eec-9647-95bcedd33b90 Co-authored-by: EMaher <9244742+EMaher@users.noreply.github.com> * chore: remove accidental temp commit message file Agent-Logs-Url: https://github.com/Azure/apiops-cli/sessions/55ca6c66-0c45-4eec-9647-95bcedd33b90 Co-authored-by: EMaher <9244742+EMaher@users.noreply.github.com> * feat: revise air-gapped Azure DevOps doc per PR feedback - Make local npm registry (Azure Artifacts) the primary approach - Demote tarball flow to fallback section - Remove redundant npm and transfer mechanism prerequisites - Add official Microsoft docs links (agents, feeds, on-prem, sovereign clouds) - Replace brittle embedded YAML with edit guidance referencing generated files - Add sovereign clouds and on-premises section Closes #44 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: EMaher <9244742+EMaher@users.noreply.github.com> * updating articles for air-gapped environments * reverting changes to squad * modifying doc tree * updating instructions for 'npm ci --offline' * removing my name from squad history * updating docwriter charter * Updating squad to backup assertions with source URLs * chore: add local feed npmrc * updating devcontainer extensions * revert: remove accidentally committed .npmrc * update charter for docwriter and code reviewer * update devops air-gapped doc command. --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: EMaher <9244742+EMaher@users.noreply.github.com> Co-authored-by: Elizabeth Maher <enewman@microsoft.com>
1 parent 14cf917 commit cbe134f

15 files changed

Lines changed: 1105 additions & 4 deletions

.devcontainer/devcontainer.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,12 @@
3131
"vitest.explorer",
3232
"GitHub.vscode-pull-request-github",
3333
"GitHub.copilot-chat",
34-
"GitHub.vscode-github-actions",
3534
"ms-azuretools.vscode-azureresourcegroups",
3635
"ms-azure-devops.azure-pipelines",
3736
"vitest.dev",
3837
"ms-vscode.powershell",
39-
"ms-azuretools.vscode-bicep"
38+
"ms-azuretools.vscode-bicep",
39+
"bierner.markdown-preview-github-styles"
4040
]
4141
}
4242
},

.squad/agents/codereviewer/charter.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,10 @@ These are patterns specific to this codebase. I check every one on every review.
110110
- ARM URI builders and parsers must handle workspace-scoped resources
111111
- Workspace context must propagate through extract/publish pipelines
112112

113+
#### Documentation Shell Snippets
114+
- For Bash heredocs in docs, opener and closing delimiter lines (for example, `<<JSON` and `JSON`) must start at column 1 in the snippet.
115+
- Indented heredoc delimiters in documentation are a **🟡 Required change** because they can leave Git Bash at a hanging continuation prompt.
116+
113117
### Severity Levels
114118

115119
- **🔴 Blocker** — Constitution violation, secret leak, untestable design, `any` type, missing `.js` import extension, typed DTO for APIM payload, data mutation of shared state. **PR cannot merge.** I will not approve with open blockers under any circumstances.

.squad/agents/docwriter/charter.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,13 @@ Technical Writer specializing in user-facing documentation for API developers.
3030
## Output Standards
3131

3232
- All docs in `/docs` unless otherwise specified
33-
- Use GitHub-Flavored Markdown (GFM)
3433
- Mermaid blocks use ```mermaid fenced code blocks
3534
- File names: lowercase, hyphen-separated (e.g., `getting-started.md`, `architecture-overview.md`)
3635
- Include front matter or clear H1 title in every document
3736
- Cross-reference related docs with relative links
37+
- Back decisions, notes, and factual assertions with a credible source URL whenever possible
38+
- REQUIRED: Use GitHub-Flavored Markdown (https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)
39+
- Bash heredoc safety rule: when examples use heredocs, the opener and closing delimiter (for example, `<<JSON` and `JSON`) must start at column 1 in the snippet. Do not indent heredoc lines.
3840

3941
## Accuracy Policy — CRITICAL
4042

.squad/agents/nodejsdev/charter.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,3 +105,7 @@ After making a decision others should know, write it to `.squad/decisions/inbox/
105105
## Voice
106106

107107
Exit codes matter. If a pipeline can't distinguish "publish succeeded" from "publish failed with partial writes" from "auth error," the tool is not CI/CD-ready. I will add distinct exit codes and I will document them. The same goes for `--format json` — structured output is a contract, not a convenience. If the JSON shape changes between versions, that's a breaking change and it needs a semver bump.
108+
109+
## Evidence Standard
110+
111+
- Back decisions, notes, and factual assertions with a credible source URL whenever possible

.squad/agents/ralph/charter.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,7 @@ Persistent memory agent that maintains context across sessions.
1818
- Read project context and team decisions before starting work
1919
- Communicate clearly with team members
2020
- Follow established patterns and conventions
21+
22+
## Evidence Standard
23+
24+
- Back decisions, notes, and factual assertions with a credible source URL whenever possible

.squad/agents/scribe/charter.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,14 @@ Documentation specialist maintaining history, decisions, and technical records.
1212
- Collaborate with team members on assigned work
1313
- Maintain code quality and project standards
1414
- Document decisions and progress in history
15+
- Keep updates as terse as possible while preserving critical context
16+
- Treat all `.squad/` files as public records; never store personally identifiable information (PII)
17+
- When recording decisions, notes, or technical assertions, include a credible source URL whenever possible
1518

1619
## Work Style
1720

1821
- Read project context and team decisions before starting work
1922
- Communicate clearly with team members
2023
- Follow established patterns and conventions
24+
- Prefer concise, high-signal summaries over narrative detail
25+
- Redact names, emails, local user paths, and other personal identifiers in all squad artifacts

.squad/decisions.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,19 @@
22

33
## Active Decisions
44

5+
### 2026-05-28T23:06:01Z: Team-Wide Evidence Standard
6+
**By:** User directive (anonymized)
7+
**Status:** Active directive
8+
**What:** All team members should back decisions, notes, and factual assertions with a credible source URL whenever possible.
9+
**Why:** Strengthens traceability and reviewability across public squad records.
10+
11+
### 2026-05-28T22:55:05Z: DocWriter Uses GitHub-Style Markdown
12+
**By:** User directive (anonymized)
13+
**Status:** Active directive
14+
**What:** All documentation and guidance authored by DocWriter must use GitHub-style Markdown.
15+
**Why:** Ensures consistent rendering, readability, and contribution standards across repository documentation.
16+
**Source:** [Basic writing and formatting syntax - GitHub Docs](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)
17+
518
### 2026-05-14T05:20:00Z: APIM v1 → v2 SKU Migration via apiops-cli
619
**By:** ApimExpert + ApiOpsLead (joint research and decision)
720
**Status:** Proposed for team governance review

.vscode/extensions.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44
"ms-vscode.vscode-typescript-next",
55
"vitest.explorer",
66
"GitHub.vscode-pull-request-github",
7-
"GitHub.copilot",
87
"GitHub.copilot-chat",
98
"ms-azuretools.vscode-azureresourcegroups",
109
"ms-azure-devops.azure-pipelines"

docs/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
| [Getting Started](getting-started.md) | Install and run your first extract → publish cycle in 10 minutes |
1010
| [Command Reference](commands/) | Detailed docs for [extract](commands/extract.md), [publish](commands/publish.md), [init](commands/init.md) |
1111
| [CI/CD Integration](ci-cd/) | Set up [GitHub Actions](ci-cd/github-actions.md) or [Azure DevOps](ci-cd/azure-devops.md) pipelines |
12+
| [Walkthroughs](walkthrough/) | Step-by-step guides: [Air-gapped GitHub Actions](walkthrough/air-gapped-github-actions.md) (local registry or offline tarball), [Air-gapped Azure DevOps](walkthrough/air-gapped-azure-devops.md) (local registry or offline tarball) |
1213

1314
## How It Works
1415

@@ -78,6 +79,9 @@ docs/
7879
├── architecture/
7980
│ ├── overview.md — System design overview
8081
│ └── design-principles.md — Architecture principles
82+
├── walkthrough/
83+
│ ├── air-gapped-github-actions.md — Using `apiops` in air-gapped CI/CD (GitHub Actions)
84+
│ ├── air-gapped-azure-devops.md — Using `apiops` in air-gapped CI/CD (Azure DevOps)
8185
└── troubleshooting/
8286
├── common-errors.md — Error messages and solutions
8387
├── debugging-guide.md — Debugging with --log-level

0 commit comments

Comments
 (0)