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

Create mermaid diagrams #4

Open
gforcada opened this issue May 15, 2023 · 0 comments
Open

Create mermaid diagrams #4

gforcada opened this issue May 15, 2023 · 0 comments

Comments

@gforcada
Copy link
Member

gforcada commented May 15, 2023

Unfortunately GitHub does not support the DOT format, but instead the mermaid one

A simple example:

graph TD;
    plone.app.layout[plone.app.layout\n2.3.x]
    plone.app.dexterity[plone.app.dexterity\n3.x]
    plone.base[plone.base\n1.x]
    Zope[Zope and friends]

    plone.app.layout-->plone.base;
    plone.app.layout-->plone.app.dexterity;
    plone.app.dexterity-->plone.base;
    plone.base-->Zope;

Source:

graph TD;
    plone.app.layout[plone.app.layout\n2.3.x]
    plone.app.dexterity[plone.app.dexterity\n3.x]
    plone.base[plone.base\n1.x]
    Zope[Zope and friends]

    plone.app.layout-->plone.base;
    plone.app.layout-->plone.app.dexterity;
    plone.app.dexterity-->plone.base;
    plone.base-->Zope;

Notice that one has to specify identifiers and labels id[visual label] and on the edges can only use identifiers id1-->id2.

The idea would be to get pipforester run on all Plone repositories and output the circular dependencies in the GHA job summary. 🚀

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

No branches or pull requests

1 participant