Changelogs for versions so scripts can be more easily upgraded

[mjperez-usgs]

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request

Module Version

• 4.2.0

Affected Resource(s)

• argis-powershell-dsc

Configuration Files

N/A

Expected Behavior

Changelogs that detail changes to the json format/breaking changes would exist between versions.

Actual Behavior

There doesn't appear to be a changelog.

Steps to Reproduce

N/A

Important Factoids

It would be nice to have changelogs between versions of arcgis-powershell-dsc that detail what changes there are in the .json files used for provisioning. EDIT: It is available it seems in the Releases page. However, I am not downloading a release - I am using nuget. It would be nice to have a link to it on the main page because I don't have a need to go the releases page. I know that is likely a significant amount of work, but I have many scripts to update for this new version when upgrading my own servers, but the scripts fail at various points due to changes, such as changes to how Web Adaptor is installed.

For example, on one script for 11.1 that does not work for 11.2, I have the error [ERROR] Starting from version 4.2.0, the DSC Module requires a different way of specifying the Web Adaptor Node configuration. Please make sure to update your configuration file.. Looking at the repository though, I see nothing that details what actually changed here, except for the variables page, which is very long and difficult to use in this scenario as I'm not really sure what I'm even looking for.

A document detailing some of the changes would be helpful, for example how .net does it: https://learn.microsoft.com/en-us/dotnet/core/compatibility/6.0

References

Variables page: https://github.com/Esri/arcgis-powershell-dsc/wiki/v4.2.0-Variables-reference-page-for-JSON-configuration-files