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

Fixes Javadocs build & adds workflow to ensure no more breakages #4168

Merged
merged 1 commit into from
Apr 5, 2024

Conversation

WalshyDev
Copy link
Member

@WalshyDev WalshyDev commented Apr 5, 2024

Description

The javadocs have again been broken for a while, I said I wanted to do this last time and forgot. So now, we're gonna both fix the docs and add validation to this repo.

Proposed changes

  • Adds a new workflow "Javadocs" to validate that we can build the javadocs and there are no errors
  • Fixes the javadoc errors in ThreadService
  • Changes the destination dir of the javadocs since we now have a real "docs" dir

Related Issues (if applicable)

N/A

Checklist

  • I have fully tested the proposed changes and promise that they will not break everything into chaos.
  • I have also tested the proposed changes in combination with various popular addons and can confirm my changes do not break them.
  • I have made sure that the proposed changes do not break compatibility across the supported Minecraft versions (1.16.* - 1.20.*).
  • I followed the existing code standards and didn't mess up the formatting.
  • I did my best to add documentation to any public classes or methods I added.
  • I have added Nonnull and Nullable annotations to my methods to indicate their behaviour for null values
  • I added sufficient Unit Tests to cover my code.

@WalshyDev WalshyDev requested review from a team as code owners April 5, 2024 02:39
@github-actions github-actions bot added the ✨ Fix This Pull Request fixes an issue. label Apr 5, 2024
Copy link
Contributor

github-actions bot commented Apr 5, 2024

Your Pull Request was automatically labelled as: "✨ Fix"
Thank you for contributing to this project! ❤️

Copy link

sonarcloud bot commented Apr 5, 2024

Quality Gate Passed Quality Gate passed

Issues
8 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

Copy link
Contributor

github-actions bot commented Apr 5, 2024

Slimefun preview build

A Slimefun preview build is available for testing!
Commit: 85883036

https://preview-builds.walshy.dev/download/Slimefun/4168/85883036

Note: This is not a supported build and is only here for the purposes of testing.
Do not run this on a live server and do not report bugs anywhere but this PR!

WalshyDev added a commit to Slimefun/javadocs that referenced this pull request Apr 5, 2024
Copy link
Contributor

@JustAHuman-xD JustAHuman-xD left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Workflows are in my realm of little knowledge, from looking at it it looks good but im also not a professional in this area 😅

@WalshyDev WalshyDev merged commit 03e5b9a into master Apr 5, 2024
19 checks passed
@WalshyDev WalshyDev deleted the fix/javadocs-and-add-validation branch April 5, 2024 19:36
WalshyDev added a commit to Slimefun/javadocs that referenced this pull request Apr 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
✨ Fix This Pull Request fixes an issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants