Repository navigation
fix(javadoc): unbreak the release build and align examples with the code - #470
Merged
Merged
Conversation
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## beta #470 +/- ##
============================================
- Coverage 51.66% 48.72% -2.94%
Complexity 712 712
============================================
Files 299 325 +26
Lines 10532 11166 +634
Branches 1299 1315 +16
============================================
Hits 5441 5441
- Misses 4073 4707 +634
Partials 1018 1018 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
mvn deploy -P releasecurrently fails onbeta.The javadoc plugin rejects 23
{@link}references introduced by #460: the deprecated per-type library requests point atSaveItemsToLibraryRequest,RemoveItemsFromLibraryRequestandCheckUsersSavedItemsRequestfromrequests.data.albums,audiobooks,episodes,showsandtrackswithout importing them.javac ignores comments, so pull request CI and the tag job's Build step both pass.
The failure lands in the Release step, which runs after the tag is pushed, and it takes
changelogithubdown with it.Tagging v10 today would leave a tag with nothing on Maven Central and no GitHub release.
This qualifies those references, documents the eight members that came in undocumented alongside them, and fixes the documentation drift found while checking the rest.
26 endpoints had no example at all, among them⚠️ markers disagreed with the
createPlaylist, the endpoint #453 reported missing and #454 added.31 example classes still carried their pre-#460 names, for instance
GetAlbumsTracksExamplecallinggetAlbumTracks, and the entire player package.The README linked
examples/data/artists/, a directory rather than a file, and 12 of its 21@Deprecatedannotations in the code.The example index is now generated from the code: 115 entries, every link resolving, every marker matching.
To keep it that way,⚠️ markers match
ci/check-docs.pyruns on every build.It verifies that every
SpotifyApibuilder method has an example, that example class names match their request classes, that every example is linked from the README and every link resolves, that the@Deprecated, and that deprecation in the code matchesspec/openapi.yamlfrom #469.That last check passes for all 106 spec-backed request classes today.
A second step builds the javadoc through a new
javadoc-checkprofile that writes totarget/, so a broken reference fails the pull request instead of the release.The only change outside documentation is
@Deprecatedon the five legacy playlist builders, which matches how the other deprecated request classes are annotated.No request class, builder method or signature changed.
apidocs/is deliberately left alone: this repository regenerates it in the release commit, every file carries a generation timestamp, and it would go stale again at the v10 commit.387 tests pass, the javadoc build reports no errors and no warnings, and the checker reports no drift.