8000 [FrameworkBundle][Workflow] Add metadata dumping support for `GraphvizDumper` by Louis-Proffit · Pull Request #50621 · symfony/symfony · GitHub
[go: up one dir, main page]

Skip to content

[FrameworkBundle][Workflow] Add metadata dumping support for GraphvizDumper #50621

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

Merged
merged 1 commit into from
Jun 21, 2023

Conversation

Louis-Proffit
Copy link
Contributor
@Louis-Proffit Louis-Proffit commented Jun 9, 2023
Q A
Branch? 6.4
Bug fix? no
New feature? yes
Deprecations? no
Tickets Fix #50604
License MIT
Doc PR symfony/symfony-docs#18398

Add --with-metadata option to workflow:dump command. It includes places, transitions and workflow's metadata in the dumped graph. Currently only supported for GraphvizDumper and StateMachineGraphvizDumper.

When used, the label metadata is not included in the dumped metadata because it is already the title. This could be enlarged to all styling metadata.

@carsonbot
Copy link

Hey!

I see that this is your first PR. That is great! Welcome!

Symfony has a contribution guide which I suggest you to read.

In short:

  • Always add tests
  • Keep backward compatibility (see https://symfony.com/bc).
  • Bug fixes must be submitted against the lowest maintained branch where they apply (see https://symfony.com/releases)
  • Features and deprecations must be submitted against the 6.4 branch.

Review the GitHub status checks of your pull request and try to solve the reported issues. If some tests are failing, try to see if they are failing because of this change.

When two Symfony core team members approve this change, it will be merged and you will become an official Symfony contributor!
If this PR is merged in a lower version branch, it will be merged up to all maintained branches within a few days.

I am going to sit back now and wait for the reviews.

Cheers!

Carsonbot

@carsonbot carsonbot changed the title [FrameworkBundle] add metadata dump option | [Workflow] add metada dumping support for GraphvizDumper [FrameworkBundle][Workflow] add metadata dump option | add metada dumping support for GraphvizDumper Jun 9, 2023
@Louis-Proffit Louis-Proffit changed the base branch from 6.3 to 6.4 June 14, 2023 17:00
@Louis-Proffit Louis-Proffit requested a review from jderusse as a code owner June 14, 2023 17:00
@Louis-Proffit Louis-Proffit force-pushed the ticket_50604 branch 3 times, most recently from 3e8f6a7 to 47757b7 Compare June 14, 2023 17:18
@nicolas-grekas nicolas-grekas modified the milestones: 6.3, 6.4 Jun 21, 2023
@nicolas-grekas nicolas-grekas changed the title [FrameworkBundle][Workflow] add metadata dump option | add metada dumping support for GraphvizDumper [FrameworkBundle][Workflow] Add metadata dumping support for GraphvizDumper Jun 21, 2023
@nicolas-grekas nicolas-grekas force-pushed the ticket_50604 branch 2 times, most recently from 5ff2322 to cad1bd5 Compare June 21, 2023 09:09
Copy link
Member
@nicolas-grekas nicolas-grekas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I rebased + fixed a few things.

@OskarStark OskarStark changed the title [FrameworkBundle][Workflow] Add metadata dumping support for GraphvizDumper [FrameworkBundle][Workflow] Add metadata dumping support for GraphvizDumper Jun 21, 2023
@@ -248,6 +282,9 @@ protected function escape(string|bool $value): string
return \is_bool($value) ? ($value ? '1' : '0') : addslashes($value);
}

/**
* @internal
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why make this internal?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

because all methods are in this class

@nicolas-grekas
Copy link
Member

Thank you @Louis-Proffit.

@nicolas-grekas nicolas-grekas merged commit f01da98 into symfony:6.4 Jun 21, 2023
'graph' => [
'label' => $input->getOption('label'),
],
'label' => $input->getOption('label'),
Copy link
Member
@xabbuh xabbuh Jun 21, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't this a BC break if someone uses the dumper in their own code (as they would have to change the options being passed to the dump() method)?

This was referenced Oct 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enable dumping workflow metadata
5 participants
0