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

Support for nested directories #27

Closed
jadur10 opened this issue Jan 31, 2023 · 8 comments · Fixed by #32
Closed

Support for nested directories #27

jadur10 opened this issue Jan 31, 2023 · 8 comments · Fixed by #32
Assignees
Labels
enhancement New feature or request maven

Comments

@jadur10
Copy link
Collaborator

jadur10 commented Jan 31, 2023

I have a monorepo for couple of maven projects such as
A(root)
|-B
|-C
While deploying, only javadoc from the root project (A) is included, however I would like to include javadocs for B and C.
Suggested way would be to specify (optional) subdirectories in the yaml configuration and upload the generated javadocs to javadoc/<folder_name> in the target github.io page.

@pSub
Copy link
Collaborator

pSub commented Feb 4, 2023

This should work once #28 is merged. In the meantime you can use release 2.0.4 which works as expected. I use this version for dmn-check (Repo and Javadoc).

@jadur10
Copy link
Collaborator Author

jadur10 commented Feb 6, 2023

@pSub I see what is #28 is about, but aggregate does not really work for us,
What I would want to achieve is https://<username>.github.io/<repo>/javadoc/A https://<username>.github.io/<repo>/javadoc/B structure with index.html in the main directory pointing to those folders
If that works with 2.0.4, I can close the issue, otherwise please provide an option to specify subdirectories that are uploaded.

@pSub
Copy link
Collaborator

pSub commented Feb 7, 2023

@jadur10: Thank you. Now I understand what you want. 😄
That does not work with release 2.0.4. That is nothing I need right know, but maybe @MathieuSoysal wants to implement this feature 😃

@jadur10
Copy link
Collaborator Author

jadur10 commented Feb 7, 2023

I can also implement this if you show me how :D

@MathieuSoysal
Copy link
Owner

MathieuSoysal commented Feb 7, 2023

Thank you for your feedback @jadur10 that is a good idea!

I can help you to implement this:

  1. First you need to change the option of github-deploy to set the clean to a input like clean-gh-page : here and here
  2. Second when you use javadoc-publisher CI you need to configure the input clean-gh-page to false and configure the input target-folder

Note: the first folder needs to have clean to true and the next folders need to have clean to false. Otherwise you have a conflict with the previous CI execution.

With this you can have https://.github.io//javadoc/A, https://.github.io//javadoc/B ont a same repo.

@jadur10
Copy link
Collaborator Author

jadur10 commented Feb 8, 2023

@MathieuSoysal thank you for this :) is there any way I can reach you via IM? I'm not that experienced with yaml as you might be, so would need some quick chat for assistance (I'm available Via messenger for instance)

@MathieuSoysal
Copy link
Owner

MathieuSoysal commented Feb 8, 2023

@jadur10 Yep you can, my messenger is Mathieu So

@jadur10
Copy link
Collaborator Author

jadur10 commented Feb 8, 2023

Hey, pinged you there, my name is Jacek Durlik (not that many with that name, so you can be sure this is me :) )

@MathieuSoysal MathieuSoysal added the enhancement New feature or request label Feb 10, 2023
MathieuSoysal added a commit that referenced this issue Feb 10, 2023
jadur10 pushed a commit that referenced this issue Feb 11, 2023
jadur10 pushed a commit that referenced this issue Feb 11, 2023
jadur10 pushed a commit that referenced this issue Feb 11, 2023
@MathieuSoysal MathieuSoysal linked a pull request Feb 12, 2023 that will close this issue
MathieuSoysal added a commit that referenced this issue Feb 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request maven
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants