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

Markdown generator #6758

Merged
merged 5 commits into from Mar 30, 2020
Merged

Markdown generator #6758

merged 5 commits into from Mar 30, 2020

Conversation

jgsogo
Copy link
Member

@jgsogo jgsogo commented Mar 29, 2020

Changelog: Feature: Add markdown generator, it exposes useful information to consume the installed packages.
Docs: conan-io/docs#1638

This PR adds a markdown/md generator to generate a Markdown file for each of the dependencies installed by Conan.

Besides showing useful information about each package and how to use it with different generators (add copy/paste snippet), it is trying to help with a pain some users may be facing right now: with the addition of cpp_info.names["<generator>"]] we usually need to have a look to the actual conanfile.py of the recipe or to the generated FindXXXX.cmake file in order to know the name of the target.

yea or nay? other ideas based on this one?

Mar-29-2020 19-49-23

Copy link
Member

@memsharded memsharded left a comment

I love this concept. Simple, low risk, but can be quite useful and convenient. There might be many things that could be added, for sure (maybe the options).
We are on time for 1.24, if you want to add it, I am totally ok with that, this is a very cool feature, 0 risk. Lets release it to the world.

conans/client/generators/__init__.py Show resolved Hide resolved
@jgsogo
Copy link
Member Author

@jgsogo jgsogo commented Mar 29, 2020

No need to hurry, we can wait for the next release and think about the information we can show here. For example, I'm missing the user and channel (I need them to identify the package), besides that I think this generator should show only information for the consumers, in fact it has access only to deps_cpp_info... not sure if we want to add more.

What I'd really like to create is a proper HTML with all the project and requirements, like the actual conan info --graph=xxx.html but adding all the information about the packages. That could be really nice, not sure if an external tool or an additional command.

@jgsogo jgsogo added this to the 1.24 milestone Mar 30, 2020
@jgsogo jgsogo marked this pull request as ready for review Mar 30, 2020
@jgsogo jgsogo changed the title [RFC] Markdown generator Markdown generator Mar 30, 2020
@jgsogo
Copy link
Member Author

@jgsogo jgsogo commented Mar 30, 2020

Ok, we'll merge it for 1.24, of course we should add more snippets to it and more information, this is just the first step.

@danimtb
Copy link
Member

@danimtb danimtb commented Mar 30, 2020

I think it is a good starting point and we can add more things once we get some initial feedback

@danimtb danimtb merged commit 5b0e056 into conan-io:develop Mar 30, 2020
2 checks passed
@jgsogo jgsogo deleted the generator/markdown branch Mar 30, 2020
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

Successfully merging this pull request may close these issues.

None yet

3 participants