-
Notifications
You must be signed in to change notification settings - Fork 10
[Doc Drift] README.md apiops init flags table missing --artifact-dir option #194
Copy link
Copy link
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
Activity
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)
What drifted
The
apiops initflags table inREADME.mdis 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--helpoutput and fully documented indocs/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 --helpoutput includes:docs/commands/init.md(line 49) correctly documents it: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'sinitflags table, e.g.:--artifact-dir <dir>./apim-artifacts)--cli-package <path>.tgztarball--ci <platform>github-actionsorazure-devops--environments <list>dev,prod)--non-interactive--force