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 README #4

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from
Draft

Create README #4

wants to merge 4 commits into from

Conversation

stbischof
Copy link
Contributor

@stbischof stbischof commented Jan 11, 2021

This created generated Readme using bnd exportreport readme
At the Moment it overrides existing Readme.md
@pkriens please tell me if you are interested in such a doc. Then I will clean that all up and merge existing readme.

@stbischof stbischof marked this pull request as draft January 11, 2021 12:40
@pkriens
Copy link
Member

pkriens commented Jan 11, 2021

Yes, I am interested. I recently looked at the reporting and it looks useful.

I had a few observations:

  • Do you have a git hook to generate this on commit?
  • I am a tad uncomfortable with the twig file in the same directory. One of the reasons I am not too happy with gradle is because it also pollutes the workspace directory rather massively. It would be nice if the bnd reporter could 'update' a readme. I.e. remove the old generated info and add updated information? It shouldn't be that hard to have an invisible separator, for example <!-- configuration section ..... -->

But I am rambling, please go ahead.

@stbischof
Copy link
Contributor Author

stbischof commented Jan 11, 2021

I have no git Hook. I mostly use it without maven. Is is gerates every build.
The twig file i am using is the default one if bnd. It isbinside the jar. Will work in this also in an other project next weeks then i will also do more here

@pkriens
Copy link
Member

pkriens commented Jan 11, 2021

I am using Github Actions so I never build locally, except in Eclipse. I'll make a git hook if you got it set up.

About the twig file. If I can find time, I'll make a proposal how I would like to see it.

But please go ahead.

Signed-off-by: Stefan Bischof <[email protected]>
@stbischof
Copy link
Contributor Author

Code-Using chapter would be generated from Code-Snippets of
biz.aQute.osgi.configuration.util/src/test/java/examples/*

Example: Readme.java
https://github.com/bndtools/bnd/tree/master/biz.aQute.bnd.reporter/test/biz/aQute/bnd/reporter/codesnippet

Signed-off-by: Stefan Bischof <[email protected]>
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.

2 participants