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.

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

Jump to bottom

Updated to document breaking changes #762

Merged
merged 13 commits into from
Oct 16, 2023
Merged

Updated to document breaking changes #762

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
7485fdf
Updated to document importing feature flag breaking change
May 18, 2023
be73f89
Updated to document breaking changes
May 25, 2023
92944e7
Updated to document key vault references breaking change
Jun 6, 2023
c9b658b
Removed extra whitespace
Jun 8, 2023
35f3669
Address PR comments
Aug 1, 2023
b9fdfcf
Removed bullet
Aug 1, 2023
04b183b
Removed before/after in pull task
Aug 7, 2023
ff9f979
Updated to have breaking change as a header
Aug 9, 2023
0e58ad1
Removed colon
Aug 9, 2023
ad39dff
Removed colon
Aug 9, 2023
1f9c9fd
Address PR comments
Oct 14, 2023
84aa402
Address PR comments
Oct 14, 2023
10a5d46
Update releaseNotes/AzureDevOpsPushPipelineExtension.md
MaryanneNjeri Oct 16, 2023
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
Prev Previous commit
Next Next commit
Removed bullet
  • Loading branch information
Maryanne Njeri committed Aug 1, 2023
commit b9fdfcf744b0ddec55960393a011c12e7fd46cd7
2 changes: 1 addition & 1 deletion releaseNotes/AzureDevOpsPushPipelineExtension.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Azure App Configuration Push extension for Azure DevOps pipeline can be installe
![sample](pictures/AzureDevOpsPushExtensionVersionSample.PNG)

### v5.0.0 - February, 02 2023
* **Breaking Changes**:
**Breaking Changes**:
- Updated the task to require Node.js 16. It previously required 10.
- Updated the minimum supported azure pipeline agent version to [2.206.1](https://github.com/microsoft/azure-pipelines-agent/releases/tag/v2.206.1) or later. Previously it was [2.144.0](https://github.com/microsoft/azure-pipelines-agent/releases/tag/v2.144.0).
- Importing key vault references value as an escaped json strings is not supported, please specify the key vault reference value as a json object.
Copy link
Member

Choose a reason for hiding this comment

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

This is a change for all files using application/json content type right, not just kv set? If so, we'll want to call that out.

Also, may help to provide a snippet of what has changed.

Something like

Before when you had this

bla bla

you got this

bla bla bla

Now, the input needs to be

bla bla bla

Copy link
Contributor Author

@MaryanneNjeri MaryanneNjeri Oct 13, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

It only applies for default content profile, using application/json content type.
How about something like :
"Importing configurations with values as escaped json strings and the content type "application/json" is no longer supported. Please specify value as a json object."

Before

{  
  "app": "{\"uri\":\"https://keyvault.vault.azure.net/secrets/secret\"}"
}

Results:

Key Value
app {"uri":"https://keyvault.vault.azure.net/secrets/secret"}

After

{  
  "app": {
      "uri": "https://keyvault.vault.azure.net/secrets/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.

I was thinking since the breaking change is in relation to importing configurations, we can show the before and after of the snipped that has changed and skip showing the results

Copy link
Member

Choose a reason for hiding this comment

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

How about something like :
"Importing configurations with values as escaped json strings and the content type "application/json" is no longer supported. Please specify value as a json object."

I would avoid the phrase "is no longer supported." It's not that we removed support but rather we changed the behavior. We now convert the values of properties in the settings to json strings.

I was thinking since the breaking change is in relation to importing configurations, we can show the before and after of the snipped that has changed and skip showing the results

Sounds reasonable. But, I would include the content type that goes with the associated input snippet

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 would avoid the phrase "is no longer supported." It's not that we removed support but rather we changed the behavior. We now convert the values of properties in the settings to json strings.

Yes good point.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This has been updated thanks

Expand Down