The Wayback Machine - https://web.archive.org/web/20201224110958/https://github.com/getsentry/sentry-java/pull/1009
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

Generate Javadocs on Github Pages #1009

Merged
merged 8 commits into from Oct 22, 2020
Merged

Generate Javadocs on Github Pages #1009

merged 8 commits into from Oct 22, 2020

Conversation

@maciejwalkowiak
Copy link
Collaborator

@maciejwalkowiak maciejwalkowiak commented Oct 22, 2020

📢 Type of change

  • Bugfix
  • New feature
  • Enhancement
  • Refactoring

📜 Description

Generate Javadocs for all projects except samples and pubilsh them on github pages.

💡 Motivation and Context

Give users an easy way to read javadocs in the browser, similar to .NET equivalent https://getsentry.github.io/sentry-dotnet/api/index.html

💚 How did you test it?

I deployed javadocs site to temporary location: https://temp-javadocs.surge.sh/
Github Action has been tested in my forked repo: https://github.com/maciejwalkowiak/sentry-java/runs/1294818436?check_suite_focus=true

📝 Checklist

  • I reviewed submitted code
  • I added tests to verify changes
  • All tests passing
  • No breaking changes

🔮 Next steps

Stylesheet is optional. In case you don't like it we can get back to the default that will look like this: https://docs.spring.io/spring-amqp/docs/2.2.10.RELEASE/api/

Copy link
Contributor

@marandaneto marandaneto left a comment

this is huge, very happy to see it.
Stylesheet came to stay IMO.
LGTM

Copy link
Member

@bruno-garcia bruno-garcia left a comment

This was on our backlog for a year :)

Thanks a lot @maciejwalkowiak

@bruno-garcia bruno-garcia merged commit 50449af into main Oct 22, 2020
10 of 11 checks passed
10 of 11 checks passed
validate-changelog validate-changelog
Details
Validation
Details
Build Job ubuntu-latest
Details
Build Job macos-latest
Details
Build and deploy Javadocs
Details
Release
Details
Travis CI - Pull Request Build Passed
Details
codecov/patch Coverage not affected when comparing 17eb856...b48d274
Details
codecov/project 71.61% (+71.61%) compared to 17eb856
Details
continuous-integration/appveyor/branch AppVeyor build succeeded
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
@bruno-garcia bruno-garcia deleted the javadocs-gh-pages branch Oct 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants
You can’t perform that action at this time.