spin icon indicating copy to clipboard operation
spin copied to clipboard

remove up flag on spin build

Open michelleN opened this issue 2 years ago • 4 comments

With #1776, we will have a build flag on spin up. We should remove the up flag on spin build with spin 2.0 since that is an opportunity for a breaking change.

https://github.com/fermyon/spin/pull/1776#issuecomment-1726189760

michelleN avatar Sep 19 '23 21:09 michelleN

This seems like it could break a lot of people's muscle memory - is there a strong reason for removing it?

itowlson avatar Sep 25 '23 20:09 itowlson

That's a good point. Reasoning is from the thread mentioned above. There are now 3 ways to do the same thing. It'd be nice to consolidate but perhaps removing the flag from build altogether doesn't have to be the way to do it. Perhaps, we can first switch to all the docs using spin up --build rather than spin build --up and on the next major version we could remove the up flag from build. Do you think that makes sense? or would you rather have spin build --up forever (for now)?

michelleN avatar Sep 25 '23 20:09 michelleN

Without telemetry, it's hard to say how prevalent that muscle memory would be. My removal plan would be:

  1. Switch docs over to use up --build and wait (for people to widely see the new pattern)
  2. Announce plan to deprecate build --up and wait (to gather reaction and to let the message percolate out)
  3. Deprecate build --up and wait (for feedback and complaints)
  4. Remove build --up

Steps 3 and 4 feel like major version events, though others may disagree.

(By the way, what is the third way to do the same thing? I can only think of build --up and up --build. Is it spin build && spin up?)

itowlson avatar Sep 25 '23 20:09 itowlson

That sounds like a great plan @itowlson !

third way to iterate locally being spin watch

michelleN avatar Sep 25 '23 21:09 michelleN