Always export Set-AzOpsWhatIfOutput results to json file about azops HOT 7 CLOSED

While having the comments posted into the gh pr is "fine" and good if the length is smaller <64k, I think you should give me a file reference to the whole log and allow me to make it an action run artifact instead! I can open the whole thing, no matter how many characters, as I please!

Here's a thought: Always give me the file reference so I can make it into an artifact, as mentioned, AND take the first 64k characters and put into the comment as you are attempting to do today - but also CLEARLY state that there is more which did not fit here.

I think it would be worse to start adding many gh pr comments, because it will be difficult to read and the length of it all makes it less useful. If the output is so lengthy, then it is better to use it as an artifact!

Does that make sense?

from azops.

That is excellent! I will try this out and let you know. I would propose you document how to turn that into an artefact! And I also propose you put as much as possible into on GH comment, but not multiple comments. I'd rather you reference the full file instead. I think multiple comments will look weird

from azops.

Sorry, that does not work. When the result is too long the file is NOT generated at all.

AzOps/src/internal/functions/Set-AzOpsWhatIfOutput.ps1

Line 65 in 061d024

$mdOutput = 'WhatIf Results for {1}:{0} WhatIf is too large for comment field, for more details look at PR files to determine changes.' -f [environment]::NewLine, $resultHeadline

I get the message here from the if-statement. You are referring to a code line in the else section.

We'd need a code change to always generate the file content, regardless if it is too long for a GH comment!

You are right, apparently I was too quick when scrolling through the references yesterday. We'll make sure to fix that in our next release.

from azops.

Thanks for the feedback, @noopman.

The limitation is attributed to the ADO/GitHub comment constraints.
#417
https://github.com/orgs/community/discussions/41331

We are contemplating posting larger WhatIf outputs by dividing them into N comments instead of not posting at all. Your thoughts?

We do, in fact, create a file named output.json containing the raw WhatIf output. Consequently, if you wish, you have the option to upload and store that file elsewhere as well.
https://github.com/Azure/AzOps/blob/main/src/internal/functions/Set-AzOpsWhatIfOutput.ps1#L89

from azops.

I also find it weird that GH has not documented the comment length requirement.

from azops.

While having the comments posted into the gh pr is "fine" and good if the length is smaller <64k, I think you should give me a file reference to the whole log and allow me to make it an action run artifact instead! I can open the whole thing, no matter how many characters, as I please!

Here's a thought: Always give me the file reference so I can make it into an artifact, as mentioned, AND take the first 64k characters and put into the comment as you are attempting to do today - but also CLEARLY state that there is more which did not fit here.

I think it would be worse to start adding many gh pr comments, because it will be difficult to read and the length of it all makes it less useful. If the output is so lengthy, then it is better to use it as an artifact!

Does that make sense?

See my updated comment, we actually do have a hardcoded file reference for the output. We can certainly document this if it helps.

from azops.

Sorry, that does not work. When the result is too long the file is NOT generated at all.

I get the message here from the if-statement. You are referring to a code line in the else section.

We'd need a code change to always generate the file content, regardless if it is too long for a GH comment!

from azops.