Skip to content

Commit

Permalink
[App Configuration] Update App Configuration tasks description (#20682)
Browse files Browse the repository at this point in the history
* Update App Configuration tasks description

* Update App Configuration tasks description

* Address PR comment

* Address PR comments

---------

Co-authored-by: Maryanne Njeri <mgichohi@microsoft.com>
  • Loading branch information
MaryanneNjeri and Maryanne Njeri authored Dec 2, 2024
1 parent 7df4852 commit 92673cc
Show file tree
Hide file tree
Showing 13 changed files with 30 additions and 30 deletions.
4 changes: 2 additions & 2 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ Tasks/AppCenterTestV1/ @imenkov @lucen-ms @DergachevE
Tasks/ArchiveFilesV2/ @microsoft/akvelon-build-task-team

# DRI Rotation for @microsoft/release-management-task-team : DRI-ReleaseManagement
Tasks/AzureAppConfigurationV10/ @microsoft/azure-appconfig-team
Tasks/AzureAppConfigurationExportV10/ @microsoft/azure-appconfig-team

Tasks/AzureAppConfigurationPushV10/ @microsoft/azure-appconfig-team
Tasks/AzureAppConfigurationImportV10/ @microsoft/azure-appconfig-team

Tasks/AzureAppConfigurationSnapshotV1/ @microsoft/azure-appconfig-team

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"loc.friendlyName": "Azure App Configuration Export",
"loc.helpMarkDown": "Email AzureAppConfig@microsoft.com for questions.",
"loc.description": "Download key-values to task variables from Azure App Configuration",
"loc.description": "Export key-values to task variables from Azure App Configuration",
"loc.instanceNameFormat": "Azure App Configuration",
"loc.input.label.ConnectedServiceName": "Azure subscription",
"loc.input.help.ConnectedServiceName": "Select the Azure Subscription for the Azure App Configuration instance.",
Expand All @@ -27,7 +27,7 @@
"loc.messages.InvalidAppConfigurationEndpoint": "Invalid App Configuration endpoint %s. Please provide a valid App Configuration endpoint.",
"loc.messages.SecretUrlCannotBeEmpty": "Secret url cannot be empty",
"loc.messages.InvalidSecretUrl": "Invalid secret Url",
"loc.messages.AzureAppConfigurationTaskIsStartingUp": "Azure App Configuration Task is starting up...",
"loc.messages.AzureAppConfigurationTaskIsStartingUp": "Azure App Configuration Export Task is starting up...",
"loc.messages.AzureSubscriptionTitle": "Azure Subscription:",
"loc.messages.AppConfigurationEndpointTitle": "App Configuration Endpoint:",
"loc.messages.SelectionModeTitle": "Selection Mode:",
Expand Down
2 changes: 1 addition & 1 deletion Tasks/AzureAppConfigurationExportV10/ThirdPartyNotice.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
THIRD-PARTY SOFTWARE NOTICES AND INFORMATION
Do Not Translate or Localize

This Azure DevOps extension (AzureAppConfiguration) is based on or incorporates material from the projects listed below (Third Party IP). The original copyright notice and the license under which Microsoft received such Third Party IP, are set forth below. Such licenses and notices are provided for informational purposes only. Microsoft licenses the Third Party IP to you under the licensing terms for the Azure DevOps extension. Microsoft reserves all other rights not expressly granted under this agreement, whether by implication, estoppel or otherwise.
This Azure DevOps extension (AzureAppConfigurationExport) is based on or incorporates material from the projects listed below (Third Party IP). The original copyright notice and the license under which Microsoft received such Third Party IP, are set forth below. Such licenses and notices are provided for informational purposes only. Microsoft licenses the Third Party IP to you under the licensing terms for the Azure DevOps extension. Microsoft reserves all other rights not expressly granted under this agreement, whether by implication, estoppel or otherwise.

1. @types/mocha (git+https://github.com/DefinitelyTyped/DefinitelyTyped.git)
2. @types/node (git+https://github.com/DefinitelyTyped/DefinitelyTyped.git)
Expand Down
8 changes: 4 additions & 4 deletions Tasks/AzureAppConfigurationExportV10/task.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
"id": "81fa1f14-66ef-4e75-93fd-30b8ee7140d6",
"name": "AzureAppConfigurationExport",
"friendlyName": "Azure App Configuration Export",
"description": "Download key-values to task variables from Azure App Configuration",
"helpUrl": "https://learn.microsoft.com/azure/azure-app-configuration/pull-key-value-devops-pipeline",
"description": "Export key-values to task variables from Azure App Configuration",
"helpUrl": "https://learn.microsoft.com/azure/azure-app-configuration/azure-pipeline-export-task",
"helpMarkDown": "Email AzureAppConfig@microsoft.com for questions.",
"category": "Deploy",
"author": "Microsoft Corporation",
"version": {
"Major": 10,
"Minor": 247,
"Minor": 249,
"Patch": 0
},
"instanceNameFormat": "Azure App Configuration",
Expand Down Expand Up @@ -150,7 +150,7 @@
"InvalidAppConfigurationEndpoint": "Invalid App Configuration endpoint %s. Please provide a valid App Configuration endpoint.",
"SecretUrlCannotBeEmpty": "Secret url cannot be empty",
"InvalidSecretUrl": "Invalid secret Url",
"AzureAppConfigurationTaskIsStartingUp": "Azure App Configuration Task is starting up...",
"AzureAppConfigurationTaskIsStartingUp": "Azure App Configuration Export Task is starting up...",
"AzureSubscriptionTitle": "Azure Subscription:",
"AppConfigurationEndpointTitle": "App Configuration Endpoint:",
"SelectionModeTitle": "Selection Mode:",
Expand Down
4 changes: 2 additions & 2 deletions Tasks/AzureAppConfigurationExportV10/task.loc.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
"name": "AzureAppConfigurationExport",
"friendlyName": "ms-resource:loc.friendlyName",
"description": "ms-resource:loc.description",
"helpUrl": "https://learn.microsoft.com/azure/azure-app-configuration/pull-key-value-devops-pipeline",
"helpUrl": "https://learn.microsoft.com/azure/azure-app-configuration/azure-pipeline-export-task",
"helpMarkDown": "ms-resource:loc.helpMarkDown",
"category": "Deploy",
"author": "Microsoft Corporation",
"version": {
"Major": 10,
"Minor": 247,
"Minor": 249,
"Patch": 0
},
"instanceNameFormat": "ms-resource:loc.instanceNameFormat",
Expand Down
2 changes: 1 addition & 1 deletion Tasks/AzureAppConfigurationExportV10/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ export class Utils {

public static GenerateUserAgent(): string {
const taskVersion: string = `${TaskManifestData.version.Major}.${TaskManifestData.version.Minor}.${TaskManifestData.version.Patch}`;
const userAgent: string = `AzurePipelines.AzureAppConfiguration.Pull/${taskVersion} Node/${process["version"]} OS/(${os.arch()}-${os.type()}-${os.release()})`;
const userAgent: string = `AzurePipelines.AzureAppConfiguration.Export/${taskVersion} Node/${process["version"]} OS/(${os.arch()}-${os.type()}-${os.release()})`;
// webClient.WebRequest will load environment variable as user-agent.
return userAgent;
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"loc.friendlyName": "Azure App Configuration Import",
"loc.helpMarkDown": "Email AzureAppConfig@microsoft.com for questions.",
"loc.description": "Push key-values to an Azure App Configuration instance",
"loc.description": "Import key-values to an Azure App Configuration instance",
"loc.instanceNameFormat": "Azure App Configuration",
"loc.group.displayName.AppConfiguration": "AppConfiguration",
"loc.group.displayName.Source": "Source",
Expand Down Expand Up @@ -29,9 +29,9 @@
"loc.input.label.ContentType": "Content Type",
"loc.input.help.ContentType": "a content type to append to all keys in the configuration file",
"loc.input.label.Tags": "Tags",
"loc.input.help.Tags": "Specifies one or more tag that should be added to key-value settings being pushed to App Configuration. Tags should be of a valid JSON format and can span multiple lines. Example: {\"tag1\": \"value1\", \"tag2\": \"value2\"}",
"loc.input.help.Tags": "Specifies one or more tag that should be added to key-value settings being imported to App Configuration. Tags should be of a valid JSON format and can span multiple lines. Example: {\"tag1\": \"value1\", \"tag2\": \"value2\"}",
"loc.input.label.ExcludeFeatureFlags": "Exclude feature flags",
"loc.input.help.ExcludeFeatureFlags": "Specifies whether or not any feature flags provided in the configuration file will be pushed to App Configuration.",
"loc.input.help.ExcludeFeatureFlags": "Specifies whether or not any feature flags provided in the configuration file will be imported to App Configuration.",
"loc.input.label.Strict": "Delete key-values that are not included in the configuration file",
"loc.input.help.Strict": "The behavior of this option depends on the configuration file's content profile.\n 'Default': Any key-values in the store with the specified prefix and label that are not included in the configuration file will be deleted. \n'KVSet': Any key-values in the store that are not included in the configuration file will be deleted.",
"loc.input.label.DryRun": "Dry run",
Expand All @@ -45,7 +45,7 @@
"loc.messages.InvalidTagsWithSample": "Invalid format for parameter 'Tags'. Sample 'Tags': {\"name1\": \"value1\", \"name2\":, \"value2\"}.",
"loc.messages.InvalidAppConfigurationEndpoint": "Invalid App Configuration endpoint %s. Please provide a valid App Configuration endpoint.",
"loc.messages.InvalidTypeInTags": "Invalid type in parameter 'Tags'. Only strings supported",
"loc.messages.AzureAppConfigurationPushTaskStartingUp": "Azure App Configuration Push Task is starting up...",
"loc.messages.AzureAppConfigurationImportTaskStartingUp": "Azure App Configuration Import Task is starting up...",
"loc.messages.AzureSubscriptionTitle": "Azure Subscription:",
"loc.messages.AppConfigurationEndpointTitle": "App Configuration Endpoint:",
"loc.messages.StrictTitle": "Strict:",
Expand Down
2 changes: 1 addition & 1 deletion Tasks/AzureAppConfigurationImportV10/ThirdPartyNotices.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
THIRD-PARTY SOFTWARE NOTICES AND INFORMATION
Do Not Translate or Localize

This Azure DevOps extension (AzureAppConfigurationPush) is based on or incorporates material from the projects listed below (Third Party IP). The original copyright notice and the license under which Microsoft received such Third Party IP, are set forth below. Such licenses and notices are provided for informational purposes only. Microsoft licenses the Third Party IP to you under the licensing terms for the Azure DevOps extension. Microsoft reserves all other rights not expressly granted under this agreement, whether by implication, estoppel or otherwise.
This Azure DevOps extension (AzureAppConfigurationImport) is based on or incorporates material from the projects listed below (Third Party IP). The original copyright notice and the license under which Microsoft received such Third Party IP, are set forth below. Such licenses and notices are provided for informational purposes only. Microsoft licenses the Third Party IP to you under the licensing terms for the Azure DevOps extension. Microsoft reserves all other rights not expressly granted under this agreement, whether by implication, estoppel or otherwise.

1. @types/mocha (git+https://github.com/DefinitelyTyped/DefinitelyTyped.git)
2. @types/node (git+https://github.com/DefinitelyTyped/DefinitelyTyped.git)
Expand Down
12 changes: 6 additions & 6 deletions Tasks/AzureAppConfigurationImportV10/task.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
"id": "fd186364-adb5-43c0-91ea-c5f9daa5b747",
"name": "AzureAppConfigurationImport",
"friendlyName": "Azure App Configuration Import",
"description": "Push key-values to an Azure App Configuration instance",
"helpUrl": "https://learn.microsoft.com/azure/azure-app-configuration/push-kv-devops-pipeline",
"description": "Import key-values to an Azure App Configuration instance",
"helpUrl": "https://learn.microsoft.com/azure/azure-app-configuration/azure-pipeline-import-task",
"helpMarkDown": "Email AzureAppConfig@microsoft.com for questions.",
"category": "Utility",
"author": "Microsoft Corporation",
"version": {
"Major": 10,
"Minor": 247,
"Minor": 249,
"Patch": 0
},
"instanceNameFormat": "Azure App Configuration",
Expand Down Expand Up @@ -180,7 +180,7 @@
"label": "Tags",
"defaultValue": "",
"required": false,
"helpMarkDown": "Specifies one or more tag that should be added to key-value settings being pushed to App Configuration. Tags should be of a valid JSON format and can span multiple lines. Example: {\"tag1\": \"value1\", \"tag2\": \"value2\"}",
"helpMarkDown": "Specifies one or more tag that should be added to key-value settings being imported to App Configuration. Tags should be of a valid JSON format and can span multiple lines. Example: {\"tag1\": \"value1\", \"tag2\": \"value2\"}",
"groupName": "Options",
"properties": {
"EditableOptions": "True"
Expand All @@ -193,7 +193,7 @@
"label": "Exclude feature flags",
"defaultValue": false,
"required": false,
"helpMarkDown": "Specifies whether or not any feature flags provided in the configuration file will be pushed to App Configuration.",
"helpMarkDown": "Specifies whether or not any feature flags provided in the configuration file will be imported to App Configuration.",
"groupName": "Options",
"properties": {
"EditableOptions": "True"
Expand Down Expand Up @@ -283,7 +283,7 @@
"InvalidTagsWithSample": "Invalid format for parameter 'Tags'. Sample 'Tags': {\"name1\": \"value1\", \"name2\":, \"value2\"}.",
"InvalidAppConfigurationEndpoint": "Invalid App Configuration endpoint %s. Please provide a valid App Configuration endpoint.",
"InvalidTypeInTags": "Invalid type in parameter 'Tags'. Only strings supported",
"AzureAppConfigurationPushTaskStartingUp": "Azure App Configuration Push Task is starting up...",
"AzureAppConfigurationImportTaskStartingUp": "Azure App Configuration Import Task is starting up...",
"AzureSubscriptionTitle": "Azure Subscription:",
"AppConfigurationEndpointTitle": "App Configuration Endpoint:",
"StrictTitle": "Strict:",
Expand Down
6 changes: 3 additions & 3 deletions Tasks/AzureAppConfigurationImportV10/task.loc.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
"name": "AzureAppConfigurationImport",
"friendlyName": "ms-resource:loc.friendlyName",
"description": "ms-resource:loc.description",
"helpUrl": "https://learn.microsoft.com/azure/azure-app-configuration/push-kv-devops-pipeline",
"helpUrl": "https://learn.microsoft.com/azure/azure-app-configuration/azure-pipeline-import-task",
"helpMarkDown": "ms-resource:loc.helpMarkDown",
"category": "Utility",
"author": "Microsoft Corporation",
"version": {
"Major": 10,
"Minor": 247,
"Minor": 249,
"Patch": 0
},
"instanceNameFormat": "ms-resource:loc.instanceNameFormat",
Expand Down Expand Up @@ -283,7 +283,7 @@
"InvalidTagsWithSample": "ms-resource:loc.messages.InvalidTagsWithSample",
"InvalidAppConfigurationEndpoint": "ms-resource:loc.messages.InvalidAppConfigurationEndpoint",
"InvalidTypeInTags": "ms-resource:loc.messages.InvalidTypeInTags",
"AzureAppConfigurationPushTaskStartingUp": "ms-resource:loc.messages.AzureAppConfigurationPushTaskStartingUp",
"AzureAppConfigurationImportTaskStartingUp": "ms-resource:loc.messages.AzureAppConfigurationImportTaskStartingUp",
"AzureSubscriptionTitle": "ms-resource:loc.messages.AzureSubscriptionTitle",
"AppConfigurationEndpointTitle": "ms-resource:loc.messages.AppConfigurationEndpointTitle",
"StrictTitle": "ms-resource:loc.messages.StrictTitle",
Expand Down
2 changes: 1 addition & 1 deletion Tasks/AzureAppConfigurationImportV10/taskController.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ export class TaskController {

const format: string = this._taskParameters.useFilePathExtension ? this._taskParameters.filePath.split('.').pop().toLowerCase() : this._taskParameters.fileFormat;

console.log(tl.loc("AzureAppConfigurationPushTaskStartingUp"));
console.log(tl.loc("AzureAppConfigurationImportTaskStartingUp"));
console.log(tl.loc("AzureSubscriptionTitle"), this._taskParameters.endpoint.subscriptionName);
console.log(tl.loc("AppConfigurationEndpointTitle"), this._taskParameters.configStoreUrl);
console.log(tl.loc("StrictTitle"), this._taskParameters.strict);
Expand Down
2 changes: 1 addition & 1 deletion Tasks/AzureAppConfigurationImportV10/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ export class Utils {

const taskVersion: string = `${TaskManifestData.version.Major}.${TaskManifestData.version.Minor}.${TaskManifestData.version.Patch}`;

const userAgent: string = `AzurePipelines.AzureAppConfiguration.Push/${taskVersion}`;
const userAgent: string = `AzurePipelines.AzureAppConfiguration.Import/${taskVersion}`;

// webClient.WebRequest will load environment variable as user-agent.
return userAgent;
Expand Down
4 changes: 2 additions & 2 deletions make-options.json
Original file line number Diff line number Diff line change
Expand Up @@ -432,9 +432,9 @@
"AppCenterDistributeV3",
"AppCenterTestV1",
"ArchiveFilesV2",
"AzureAppConfigurationPushV10",
"AzureAppConfigurationImportV10",
"AzureAppConfigurationSnapshotV1",
"AzureAppConfigurationV10",
"AzureAppConfigurationExportV10",
"AzureAppServiceManageV0",
"AzureAppServiceSettingsV1",
"Not compiling yet: AzureCLIV1",
Expand Down

0 comments on commit 92673cc

Please sign in to comment.