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

Add javadoc action #30

Merged
merged 6 commits into from
May 28, 2024
Merged

Add javadoc action #30

merged 6 commits into from
May 28, 2024

Conversation

alanocallaghan
Copy link
Contributor

This builds javadoc on main and publishes it to the latest subdir

vX.Y tags also get built and published to a tag subdirectory

The top level index points to stable/index.html, and stable is a symlink pointing to a tag subdirectory. Currently 0.1.4.

I've only published the 0.1.4, I was gonna build the rest but seems pointless for now.

For new tags, the second job in the action updates the stable link to point to the docs for the current tag. Maybe a problem if we ever publish versions out of order (eg we publish 0.6.0, but find a critical bug in 0.5.3 so publish 0.5.4), but we shouldn't do that often, so I think it's fine

Output is here: https://alanocallaghan.github.io/qupath-fxtras

Absolutely not merging this on a Friday at 5pm, so will revisit next week and probably update https://github.com/qupath/javadoc/ as well... or maybe scrap this and try to do a big merged javadoc. Will see

@alanocallaghan
Copy link
Contributor Author

alanocallaghan commented May 28, 2024

Much delayed but I think this should work fine, though I also am willing to take responsibility if not

@alanocallaghan alanocallaghan merged commit e1535a6 into qupath:main May 28, 2024
1 check passed
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.

1 participant