Skip to content
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.

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

Update pipeline task release notes v7.0.0 and v6.4.0 #836

Conversation

ChristineWanjau
Copy link
Contributor

@ChristineWanjau ChristineWanjau commented Nov 20, 2023

This PR updates the release notes for the pipeline task. In the pull task 7.0.0 we have a breaking change that fails when it encounters a multiline secret and the push task we have added support to append prefix to feature flags.

@ChristineWanjau ChristineWanjau changed the title Cwanjau/update pipeline task release notes Update pipeline task release notes Nov 20, 2023
@ChristineWanjau ChristineWanjau changed the title Update pipeline task release notes Update pipeline task release notes v7.0.0 and v6.4.0 Nov 20, 2023
@@ -4,6 +4,12 @@ The Azure App Configuration extension in Azure DevOps pipeline has been publishe

![sample](pictures/AzureDevOpsExtensionVersionSample.PNG)

### v7.0.0 - November, 20 2023
**Breaking changes**
- Updated to fail task when it encounters multiline secrets.
Copy link
Contributor

Choose a reason for hiding this comment

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

Updated to fail the task if any Key Vault references cannot be resolved or if the resolved values are invalid to be set as the pipeline secret.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated

Copy link
Contributor

Choose a reason for hiding this comment

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

Updated to fail the task if any Key Vault references cannot be resolved or if the resolved values are invalid to be set as the pipeline secret.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated

**Breaking changes**
- Updated to fail task when it encounters multiline secrets.

* Added capability to optionally treat key vault resolution errors as warnings.
Copy link
Contributor

Choose a reason for hiding this comment

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

Added an option to treat Key Vault reference resolution errors as warnings.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated

Copy link
Contributor

Choose a reason for hiding this comment

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

Added an option to treat Key Vault reference resolution errors as warnings.

@@ -2,6 +2,9 @@
Azure App Configuration Push extension for Azure DevOps pipeline can be installed from the [Azure DevOps marketplace](https://marketplace.visualstudio.com/items?itemName=AzureAppConfiguration.azure-app-configuration-task-push). The version information can be found in the console when the task is executed:
![sample](pictures/AzureDevOpsPushExtensionVersionSample.PNG)

### v6.4.0 - November, 20 2023
* Support appending prefixes to feature flags.
Copy link
Contributor

Choose a reason for hiding this comment

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

Added support for a feature that allows users to add a prefix to the key name of feature flags. This will provide more flexibility and better organization of feature flags for users.

(Please add a reference to the relevant GitHub issue)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated string as suggested. Added link to github issue

**Breaking changes**
- Updated to fail the task if any Key Vault references cannot be resolved or if the resolved values are invalid to be set as the pipeline secret.

* Added an option to treat Key Vault resolution errors as warnings.
Copy link
Member

Choose a reason for hiding this comment

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

It doesn't seem like the new option we've added is a breaking change. In that case it should be under a different header than "Breaking changes"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have added another header Enhancement let me know if thats okay

@@ -4,6 +4,12 @@ The Azure App Configuration extension in Azure DevOps pipeline has been publishe

![sample](pictures/AzureDevOpsExtensionVersionSample.PNG)

### v7.0.0 - November, 20 2023
**Breaking changes**
- Updated to fail the task if any Key Vault references cannot be resolved or if the resolved values are invalid to be set as the pipeline secret.
Copy link
Member

Choose a reason for hiding this comment

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

Ideally when we call out a breaking change, we inform how to work around it. In this case the user needs to enable the option to treat key vault errors as warnings.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That's a good point. I have also added more information on a workaround, let me know if thats okay

@@ -2,6 +2,9 @@
Azure App Configuration Push extension for Azure DevOps pipeline can be installed from the [Azure DevOps marketplace](https://marketplace.visualstudio.com/items?itemName=AzureAppConfiguration.azure-app-configuration-task-push). The version information can be found in the console when the task is executed:
![sample](pictures/AzureDevOpsPushExtensionVersionSample.PNG)

### v6.4.0 - November, 20 2023
* Added support for a feature that allows users to add a prefix to the key name of feature flags. This will provide more flexibility and better organization of feature flags for users.[#810](https://github.com/Azure/AppConfiguration/issues/810).
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* Added support for a feature that allows users to add a prefix to the key name of feature flags. This will provide more flexibility and better organization of feature flags for users.[#810](https://github.com/Azure/AppConfiguration/issues/810).
* Added support for a feature that allows users to add a prefix to the key name of feature flags. This will provide more flexibility and better organization of feature flags. [#810](https://github.com/Azure/AppConfiguration/issues/810).

Co-authored-by: Jimmy Campbell <[email protected]>
@ChristineWanjau ChristineWanjau merged commit 1287d9e into Azure:main Nov 20, 2023
1 check passed
@ChristineWanjau ChristineWanjau deleted the cwanjau/updatePipelineTaskReleaseNotes branch November 20, 2023 17:24
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.

None yet

3 participants