Skip to content

refactor: environment variable names to follow a consistent naming convention#787

Draft
Pavan-Microsoft wants to merge 7 commits intodevfrom
psl-pk-standparam
Draft

refactor: environment variable names to follow a consistent naming convention#787
Pavan-Microsoft wants to merge 7 commits intodevfrom
psl-pk-standparam

Conversation

@Pavan-Microsoft
Copy link
Copy Markdown
Collaborator

Purpose

This pull request standardizes and clarifies environment variable and input naming conventions across multiple workflow files and the .env.sample file, primarily by renaming several Azure-related variables for consistency and readability. These changes affect deployment workflows and environment configuration, ensuring all references to Azure resource IDs, locations, and model names use unified and descriptive names.

Key changes include:

Environment Variable and Input Renaming for Consistency:

  • Renamed Azure resource ID variables throughout workflows and .env.sample for clarity, such as changing AZURE_EXISTING_AI_PROJECT_RESOURCE_ID to AZURE_ENV_FOUNDRY_PROJECT_RID and AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID to AZURE_ENV_LOG_ANALYTICS_WORKSPACE_RID. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11]
  • Updated Azure location and image tag variable names for clarity, e.g., AZURE_ENV_OPENAI_LOCATION to AZURE_ENV_AI_SERVICE_LOCATION and IMAGE_TAG to AZURE_ENV_IMAGE_TAG across all relevant workflow files. [1] [2] [3] [4] [5] [6] [7] [8] [9]

.env.sample Variable Updates:

  • Changed model and API version variable names to be more descriptive and environment-specific, such as AZURE_OPENAI_GPT_MODEL to AZURE_ENV_GPT_MODEL_NAME, AZURE_OPENAI_IMAGE_MODEL to AZURE_ENV_IMAGE_MODEL_NAME, and AZURE_OPENAI_API_VERSION to AZURE_ENV_OPENAI_API_VERSION. [1] [2]

Workflow Logic and Output Adjustments:

  • Updated workflow scripts and validation logic to use the new variable names, ensuring all validation, output, and referencing logic matches the standardized naming. [1] [2] [3] [4]

These changes improve maintainability and reduce confusion by enforcing a clear and consistent naming scheme for all Azure-related configuration and workflow variables.

Does this introduce a breaking change?

  • Yes
  • No

Golden Path Validation

  • I have tested the primary workflows (the "golden path") to ensure they function correctly without errors.

Deployment Validation

  • I have validated the deployment process successfully and all services are running as expected with this change.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants