Skip to content

docs: CLI generation workflow for ARO HCP - #6179

Open
Ben Vesel (bennerv) wants to merge 1 commit into
Azure:mainfrom
bennerv:bvesel/cli-generation-docs
Open

docs: CLI generation workflow for ARO HCP#6179
Ben Vesel (bennerv) wants to merge 1 commit into
Azure:mainfrom
bennerv:bvesel/cli-generation-docs

Conversation

@bennerv

Copy link
Copy Markdown
Member

Summary

  • Document the Azure CLI generation and publishing workflow for ARO HCP
  • Fix TypeSpec typo in nodepool labels description ("newly create" → "newly created")
  • Clarify that ARO HCP CLI is separately maintained from ARO Classic
  • Reference upstream Azure CLI dev docs as source of truth for general workflow

Test plan

  • Verify cli-generation.md renders correctly on GitHub
  • Confirm TypeSpec change compiles

🤖 Generated with Claude Code

…ons] generation and working with

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings July 21, 2026 02:02
@openshift-ci

openshift-ci Bot commented Jul 21, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: bennerv

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates ARO-HCP documentation to describe the upstream Azure CLI (AAZ) generation/publishing workflow for the ARO HCP CLI, and applies a small wording fix in the API specs to correct a typo in nodepool label descriptions.

Changes:

  • Rewrite docs/cli-generation.md to focus on the end-to-end upstream workflow (aaz command models + generated CLI artifacts) and ARO HCP-specific generation considerations.
  • Fix the “newly create” → “newly created” typo in both the OpenAPI and TypeSpec sources for nodepool label documentation.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
docs/cli-generation.md Replaces the previous step-by-step command list with an overview of upstream repositories/artifacts and ARO HCP-specific CLI generation guidance.
api/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/hcpopenshiftclusters/preview/2024-06-10-preview/openapi.json Corrects a typo in the nodepool labels description string.
api/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/hcpopenshiftclusters/hcpCluster-models.tsp Corrects the same typo in the TypeSpec doc comment for nodepool labels.

Comment thread docs/cli-generation.md
```

Interpretation:
**Preview API versions** (e.g. `2025-12-23-preview`) produce an `aro-hcp` **extension** in `azure-cli-extensions`. Customers install it with `az extension add`.
@openshift-ci

openshift-ci Bot commented Jul 21, 2026

Copy link
Copy Markdown

Ben Vesel (@bennerv): The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/api-validation 5d250b8 link true /test api-validation

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

/** Kubernetes labels to propagate to the NodePool Nodes
* Note that when the labels are updated this is only applied to newly
* create nodes in the Nodepool, existing node labels remain unchanged.
* created nodes in the Nodepool, existing node labels remain unchanged.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants