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

feat: rename plan to visualize #471

Merged
merged 5 commits into from
Sep 14, 2023
Merged

Conversation

kanej
Copy link
Member

@kanej kanej commented Sep 14, 2023

We intend to support viewing an already run deployment, hence plan makes less sense. Instead we will go with the more generic visualize for the moment.

Resolves #450

TODO

  • Rename plan to visualize (or show)?
  • Change the result type to match as much of deploy as makes sense (validation fails, reconciliation fails, execution results)
  • After the plan result types have been recorded we want to review the names of the serialization types, and whether we can drop additional information (like chainId)

@kanej kanej force-pushed the refactor/rework-plan-to-visualize branch 2 times, most recently from 595aba6 to b0aaa04 Compare September 14, 2023 19:29
@kanej kanej marked this pull request as ready for review September 14, 2023 19:29
@kanej
Copy link
Member Author

kanej commented Sep 14, 2023

We have opted to not export visualize from core for the moment. Instead the visualize task will only leverage the IgnitionModule and the serializer.

The serializer has been tightened up to only be about IgnitionModules.

@kanej kanej force-pushed the refactor/rework-plan-to-visualize branch from b0aaa04 to a7f6071 Compare September 14, 2023 19:38
We intend to support viewing an already run deployment, hence plan makes
less sense. Instead we will go with the more generic visualize for the
moment.
Replace the deployment serializer with just an IgnitionModule
serializer.
For the moment, remove the visualize function from the public core api.

Out intent is to bring this back, returning the full deployment result
type so that a visualization can show the current journaled state of a
deployment. This will be additative to the api.
@kanej kanej force-pushed the refactor/rework-plan-to-visualize branch from a7f6071 to 656f22d Compare September 14, 2023 20:02
The chainId check test needs to read an existing deployment, the startup
time seems to trip the timeout.
@kanej kanej merged commit f68813c into development Sep 14, 2023
6 checks passed
@kanej kanej deleted the refactor/rework-plan-to-visualize branch September 14, 2023 20:22
@kanej kanej mentioned this pull request Sep 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Refactor plan return type
2 participants