Skip to content

{aks-preview} | Fixes typo Github to GitHub #4913

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zhoxing-ms merged 1 commit into from
May 31, 2022
Merged

{aks-preview} | Fixes typo Github to GitHub #4913

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 19 additions & 19 deletions src/aks-preview/azext_aks_preview/_help.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1798,7 +1798,7 @@

helps['aks draft setup-gh'] = """
type: command
short-summary: Set up Github OIDC for your application
short-summary: Set up GitHub OIDC for your application
parameters:
- name: --app
type: string
Expand All @@ -1814,25 +1814,25 @@
short-summary: Specify the cloud provider (default is azure).
- name: --gh-repo
type: string
short-summary: Specify the the github repository (organization/repo_name).
short-summary: Specify the the GitHub repository (organization/repo_name).
- name: --path
type: string
short-summary: Automatically download and use the Draft binary at the specified location.
examples:
- name: Prompt to setup the Github OIDC for a repository.
- name: Prompt to setup the GitHub OIDC for a repository.
text: az aks draft setup-gh
- name: Setup the github OIDC on Azure for a specific repository.
- name: Setup the GitHub OIDC on Azure for a specific repository.
text: az aks draft setup-gh --provider=azure --gh-repo=some_organization/some_repo
- name: Setup the github OIDC on Azure with subscription ID and resource group.
- name: Setup the GitHub OIDC on Azure with subscription ID and resource group.
text: az aks draft setup-gh --provider=azure --subscription-id=some_subscription --resource-group=some_rg
- name: Setup the github OIDC with an application name on Azure with subscription ID and resource group for a specific repository.
- name: Setup the GitHub OIDC with an application name on Azure with subscription ID and resource group for a specific repository.
text: az aks draft setup-gh --app=some_app --provider=azure --subscription-id=some_subscription --resource-group=some_rg --gh-repo=some_organization/some_repo
"""

helps['aks draft generate-workflow'] = """
type: command
short-summary: Generate a Github workflow for automatic build and deploy to AKS
long-summary: Before running this command, Make sure you have set up Github OIDC for your application.
short-summary: Generate a GitHub workflow for automatic build and deploy to AKS
long-summary: Before running this command, Make sure you have set up GitHub OIDC for your application.
You also need to create a resource group, a container registry and a Kubernetes cluster on Azure and
link the three resources using `az aks update -n <cluster-name> -g <resource-group-name> --attach-acr <acr-name>`.
parameters:
Expand All @@ -1853,24 +1853,24 @@
short-summary: Specify the name of the container image.
- name: --branch
type: string
short-summary: Specify the Github branch to automatically deploy from.
short-summary: Specify the GitHub branch to automatically deploy from.
- name: --path
type: string
short-summary: Automatically download and use the Draft binary at the specified location.
examples:
- name: Prompt to generate a Github workflow in the current directory.
- name: Prompt to generate a GitHub workflow in the current directory.
text: az aks draft generate-workflow
- name: Prompt to generate a Github workflow in a specific project directory.
- name: Prompt to generate a GitHub workflow in a specific project directory.
text: az aks draft generate-workflow --destination=/projects/some_project
- name: Generate a Github workflow with a resource group, an AKS cluster name, a container registry name in a specific project directory.
- name: Generate a GitHub workflow with a resource group, an AKS cluster name, a container registry name in a specific project directory.
text: az aks draft generate-workflow --resource-group=some_rg --cluster-name=some_cluster --registry-name=some_registry --destination=/projects/some_project
- name: Generate a Github workflow that deploys from the main branch with a resource group, an AKS cluster name, a container registry name, and a container image name in a specific project directory.
- name: Generate a GitHub workflow that deploys from the main branch with a resource group, an AKS cluster name, a container registry name, and a container image name in a specific project directory.
text: az aks draft generate-workflow --branch=main --resource-group=some_rg --cluster-name=some_cluster --registry-name=some_registry --container-name=some_image --destination=/projects/some_project
"""

helps['aks draft up'] = """
type: command
short-summary: Set up Github OIDC and generate a Github workflow for automatic build and deploy to AKS
short-summary: Set up GitHub OIDC and generate a GitHub workflow for automatic build and deploy to AKS
long-summary: This command combines `az aks draft setup-gh` and `az aks draft generate-workflow`.
Before running this command, create a resource group, a container registry and a Kubernetes cluster on Azure and
link the three resources using `az aks update -n <cluster-name> -g <resource-group-name> --attach-acr <acr-name>`.
Expand All @@ -1889,7 +1889,7 @@
short-summary: Specify the cloud provider (default is azure).
- name: --gh-repo
type: string
short-summary: Specify the the github repository (organization/repo_name).
short-summary: Specify the the GitHub repository (organization/repo_name).
- name: --cluster-name
type: string
short-summary: Specify the AKS cluster name.
Expand All @@ -1904,16 +1904,16 @@
short-summary: Specify the path to the project directory (default is .).
- name: --branch
type: string
short-summary: Specify the Github branch to automatically deploy from.
short-summary: Specify the GitHub branch to automatically deploy from.
- name: --path
type: string
short-summary: Automatically download and use the Draft binary at the specified location.
examples:
- name: Prompt to setup the Github OIDC then generate a Github workflow in the current directory.
- name: Prompt to setup the GitHub OIDC then generate a GitHub workflow in the current directory.
text: az aks draft up
- name: Prompt to setup the Github OIDC then generate a Github workflow in a specific project directory.
- name: Prompt to setup the GitHub OIDC then generate a GitHub workflow in a specific project directory.
text: az aks draft up --destination=/projects/some_project
- name: Prompt to setup the Github OIDC for a specific repository then generate a Github workflow in a specific project directory.
- name: Prompt to setup the GitHub OIDC for a specific repository then generate a GitHub workflow in a specific project directory.
text: az aks draft up --gh-repo=some_organization/some_repo --destination=/projects/some_project
"""

Expand Down