Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ocis init with diff mode #3645

Closed
dragonchaser opened this issue May 2, 2022 · 8 comments
Closed

ocis init with diff mode #3645

dragonchaser opened this issue May 2, 2022 · 8 comments
Labels

Comments

@dragonchaser
Copy link
Contributor

It would be nice add an additional diff flag to ocis init (ocis init --diff) which would, instead of creating a new ocis.yaml, output a patch that represents the changes that would be made to the config file upon re-run. This would give us the opportunity to represent breaking changes and new config variables to admins without requiring to do a deep dive into the documentation upon each major release to search for changes.

/cc @mmattel

@dragonchaser dragonchaser changed the title [Proposal] `ocis init with diff mode [Proposal] ocis init with diff mode May 2, 2022
@mmattel
Copy link
Contributor

mmattel commented May 2, 2022

Not only on restarting with the init flag, but this could also be used like a dry-run flag on first start as the file does not extist and therefore all is in the diff ! 😄

@dragonchaser dragonchaser changed the title [Proposal] ocis init with diff mode ocis init with diff mode May 2, 2022
@micbar
Copy link
Contributor

micbar commented Jul 4, 2022

Slightly related to #3917

@pmaier1 needs clarification for GA

It needs the clean deprecation of variable names in the code as a prerequisite.

@pmaier1
Copy link
Contributor

pmaier1 commented Jul 7, 2022

After GA.

@dragonchaser
Copy link
Contributor Author

This would also be a nice feature for L1/L2 support to run against the customers/users config and see potential errors.

@mmattel
Copy link
Contributor

mmattel commented Oct 5, 2023

This would be a very helpful change with regards to the upgrading documentation and eases the upgrade process a lot.

@kobergj
Copy link
Collaborator

kobergj commented Oct 5, 2023

I would rather go for an automated approach: Have new command ocis upgrade (naming tbd) that does the update automatically. To be safe about breaking change this should only print out the changes it wants to do, but don't execute them. After you checked them you can then add them to your ocis config by running ocis upgrade --execute (naming tbd)

@dragonchaser
Copy link
Contributor Author

@micbar can we move that into the next planning and talk about it?

@dragonchaser
Copy link
Contributor Author

Closing here for now, the upgrade is more complex and we should create a separate ticket for that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Done
Development

No branches or pull requests

5 participants