search

open-ortho / dcm4ceph

Convert Cephalograms from JPEG to DICOM.
MIT License
0 stars 2 forks source link

Deploy Javadocs on github pages #7

Open zgypa opened 1 year ago

zgypa commented 1 year ago
zgypa commented 1 year ago

So what's your vision for this one @tttomat19? The version of the deployed javadocs in gh-pages always matches the version deployed in master? Such that eventually there would be a an Action that builds the javadocs into gh-pages branch at each release?

zgypa commented 1 year ago

I can't merge it without at least a small explanation. Can you put something in README, even just one sentence, explaining how you build it? I would build it by cloning two versions of the repo, one on develop the other on gh-pages, then running a maven command (which?) in the develop to generate the docs, which would then go in the gh-pages clone of the repo. But you probably used a more efficient way?

Remember we are not doing automatisms here yet. Just a description like mine above would be enough.

tttomat19 commented 1 year ago

@zgypa non-automated instructions to update javadocs added at the end of main README.md file

https://github.com/open-ortho/dcm4ceph/pull/6/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5 image

Basically yes, there would be an action. Triggers for action are discussable. It would automate what is written in instructions now. One latest version is sufficient I think.

zgypa commented 1 year ago

I merged this also. Why did you choose to explicitly set docs and readme in .gitignore?

tttomat19 commented 1 year ago

Hi!

The answer about docs and readme in .gitignore is as follows.

So everything except docs and readme is ignored.

The current manual flow for updating javadocs suggest that one switches branches with git switch command or with IDE. At this moment bunch of files in working directory is not erased. Then, if one executes git add . there may be some eg. sources from other branch accidentally added to the gh-pages branch, which is unwanted. We would want only updated javadocs to be added to commit.

Merely a convenience thing.