cli-microsoft365 icon indicating copy to clipboard operation
cli-microsoft365 copied to clipboard

Deprecate the overwrite option from github workflow add command

Open Adam-it opened this issue 2 years ago • 6 comments

CI/CD pipline is rather made to continuously redeploy and overwrite existing package with new one. We should deprecate overwrite option from the command and make overwrite default behavior.

Then in v8 we should remove it related issue #5765

Adam-it avatar Jan 15 '24 22:01 Adam-it

on it

Adam-it avatar Jan 26 '24 21:01 Adam-it

@waldekmastykarz, @martinlingstuyl just having some second thoughts on this. Shouldn't we only mark the overwrite options as deprecated (add info in docs and add a warning when someone will be using it). If we also make the change to make overwrite as default won't this be a change in the current behavior which is rather considered a breaking change thing 🤔? Or do we consider this a bug?

Adam-it avatar Jan 26 '24 22:01 Adam-it

Hmmm, I see what you mean. This option should be removed in v8, but to mark it deprecated right now seems to signal the wrong thing. In the new version we'll set the overwrite behavior as default and remove the option. In the current version we should just leave it in (of course) and not mark it deprecated, I guess...

martinlingstuyl avatar Jan 26 '24 22:01 martinlingstuyl

exactly. on one hand we will mark it as deprecated so someone may think it is not recommended to use this option but on the other hand the intention is actually to use it always and we want to make it as default but since it will be a change in the behavior we may not do that just yet but with v8 🤦‍♂️ it's just so confusing WhatHuhGIF

I totally agree with what you proposed @martinlingstuyl, leave it as it is now and just remove the option and change the behavior for v8.

@pnp/cli-for-microsoft-365-maintainers any additional feedback on this one?

Adam-it avatar Jan 27 '24 21:01 Adam-it

Since the actual change that we want to do is to change the default behavior, what if we:

  • not deprecate the overwrite option now
  • in v8 make overwrite the default behavior
  • in v8 remove overwrite
  • right now, if you don't use overwrite, we show a warning saying that this behavior is deprecated and will be equal to overwrite in v8

Thoughts?

waldekmastykarz avatar Jan 28 '24 08:01 waldekmastykarz

yep, that will work as well. Let's proceed this way

Adam-it avatar Jan 28 '24 14:01 Adam-it