There are comments in all of the ci.yml files indicating that they are generated and should not be hand edited. For example:
https://github.com/Azure/azure-sdk-for-js/blob/d740741ae878d0c7055af982ffa2024127fceb0c/sdk/appconfiguration/ci.yml#L1-L2
However, apparently this isn't true and these files are in fact maintained by hand.
If that's right, I think the misleading comments should be removed.
I believe @mitchdenny would have more context here
cc @KarishmaGhiya
@nguerrera ... fair comment. Our original intention was that we would generate this files because they were mostly boilerplate. So he files were setup that way to discourage random customization until we had that setup. Right now I'm not sure if we'll ever get to that point or whether it is important. I'm in favor of removing those headers (or adding an aka.ms link which describes how to correctly modify them).
/cc @weshaggard
I was chatting with @danieljurek the other day where he needs to add more boiler plate to these files and I suggested perhaps that would be a good time to write some scripts to update/generate these files. I personally still want them to be maintained by tools and less by hand.
That said we can remove the comment as these will never be fully maintained by tools. We should however use a tool/script to remove the comments and add an aka link :smile: