Backstage Upgrade Helper should provide a Git patch

[sonytricoire]

Feature Suggestion

Backstage Upgrade Helper could provide a git patch file for a one step migration using git apply

[Rugvip]

Yep makes sense to have that easily available! I think with this in place it would be even better if we could avoid having the @backstage/* dependency bumps be part of the diff too.

Is this something you would like to contribute?

[VladMasarik]

@Rugvip Hi, I would like to contribute on this part, unless someone is already working on it.

Did I understand it correctly that one part would be to have some way of accessing the raw diff, and the second part would be to improve the diff?

My naive idea for the first one would be to just have a link right next to the "Show me how to upgrade!" button that would open a new tab with the RAW Github diff file. Would that fit our use case? For me that would be enough, although I would prefer to just directly opening up a download prompt for the diff file.

Can you expand on the second part though?

I think with this in place it would be even better if we could avoid having the @backstage/* dependency bumps be part of the diff too.

Do you mean removing code from the diff, which is meant for @backstage/* dependencies, and not for the project?

[VladMasarik]

@sonytricoire @Rugvip What do you think of the above linked PR? It is not covering the "second requirement" from Rugvip yet though, and I still have to add docs to the backstage. I will do it once we merge in the previous PR.

[sonytricoire]

Yep makes sense to have that easily available! I think with this in place it would be even better if we could avoid having the @backstage/* dependency bumps be part of the diff too.

Is this something you would like to contribute?

Hi !
Sorry but I won't have time to contribute myself.
Hopefully @VladMasarik can 👍

@VladMasarik your proposal seems ok to me (from a user perspective, I did not check technically), but I would add a short comment to explain "how to apply".

[Rugvip]

@VladMasarik yep I think that should solve it, thank you! 👍

The second requirement seems decoupled enough and can be treated as a completely separate improvement

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[benjdlambert]

@VladMasarik I think that @vinzscam got back to you in the other ticket and is awaiting your reply 🙏

[vinzscam]

Closed by backstage/upgrade-helper#8