Repository navigation
Closed
Labels
DocumentationDocumentation issues or requestsDocumentation issues or requestsclose:fixedFixed by a previous PR or releaseFixed by a previous PR or releasego:yesReady to implementReady to implementsquadSquad triage inbox — Lead will assign to a memberSquad triage inbox — Lead will assign to a membersquad:copilotAssigned to @copilot (Coding Agent) for autonomous workAssigned to @copilot (Coding Agent) for autonomous worksquad:docwriterAssigned to DocWriter (📝 Technical Writer)Assigned to DocWriter (📝 Technical Writer)
Description
What drifted
The apiops init flags table in README.md is missing the --artifact-dir <dir> option. This flag controls the artifact directory path referenced in generated CI/CD pipeline files (default: ./apim-artifacts). It is present in the CLI --help output and fully documented in docs/commands/init.md, but the README quick-reference table lists only 5 of the 6 init flags and silently omits this one.
Source of truth
apiops init --help output includes:
--artifact-dir <dir> Artifact directory path (default:
"./apim-artifacts")
docs/commands/init.md (line 49) correctly documents it:
| `--artifact-dir <dir>` | string | `./apim-artifacts` | No | Artifact directory path |
Affected documentation
README.md— theapiops initflags table (the| Flag | Description |table under### \apiops init``)
Suggested update
Add --artifact-dir <dir> as a row in the README's init flags table, e.g.:
| Flag | Description |
|---|---|
--artifact-dir <dir> |
Artifact directory path (default: ./apim-artifacts) |
--cli-package <path> |
Path to a local .tgz tarball |
--ci <platform> |
github-actions or azure-devops |
--environments <list> |
Comma-separated environments (e.g. dev,prod) |
--non-interactive |
Skip all prompts |
--force |
Overwrite existing files |
Generated by Documentation Freshness Check — System Policy · 42 AIC · ⌖ 9.17 AIC · ⊞ 6.1K · ◷
Reacted by Copilot
Metadata
Metadata
Assignees
Labels
DocumentationDocumentation issues or requestsDocumentation issues or requestsclose:fixedFixed by a previous PR or releaseFixed by a previous PR or releasego:yesReady to implementReady to implementsquadSquad triage inbox — Lead will assign to a memberSquad triage inbox — Lead will assign to a membersquad:copilotAssigned to @copilot (Coding Agent) for autonomous workAssigned to @copilot (Coding Agent) for autonomous worksquad:docwriterAssigned to DocWriter (📝 Technical Writer)Assigned to DocWriter (📝 Technical Writer)
Activity
github-actions commentedon Jul 2, 2026
📋 Issue Assignment
Assignee:
@EMaherLabels applied:
squad,squad:docwriter,squad:copilotCopilot handoff:
squad:copilotapplied — the Copilot coding agent will pick this up.Matched squad areas
squad:docwriter) — Issue is a README.md documentation drift fix: theapiops initflags table is missing a row for--artifact-dir <dir>. Routing-table examples include "README" and "Markdown docs" — direct match.Notes
No routing uncertainty. This is a pure documentation fix (add one missing row to the README flags table). No CLI code changes are needed — the flag already exists in the CLI and is documented in
docs/commands/init.md; onlyREADME.mdneeds updating.docs: add missing --artifact-dir flag to README init table (Closes #194)
feat(squad): nudge maintainer to assign Copilot when auto-assign is off
refactor(squad): post Copilot-assignment nudge via agent, not post-check
fix(squad): keep COPILOT_ASSIGN_TOKEN out of the posted issue comment
fix(squad): start coding-agent sessions for squad:copilot issues; ren…
docs: add missing `--artifact-dir` flag to README `apiops init` table (…