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

build(deps): remove dokka, no longer in use #17621

Merged
merged 1 commit into from
Dec 18, 2024

Conversation

mikehardy
Copy link
Member

Purpose / Description

It doesn't appear that we actually use dokka anymore, remove the dependency

Fixes

Approach

Remove all references to dokka in our build files

How Has This Been Tested?

We use jitpack.io to publish the API artifacts, and in our jitpack.yml we run ./gradlew :api:publishToMavenLocal

- ./gradlew :api:publishToMavenLocal

So I ran that then checked the javadoc artifact (attached) - it does generate (which is job number one) and it appears fine.

To be clear though, I'm not that interested in the output, it's mainly generated at all because some publishers (maven at least, jitpack unknown) require you to have a javadoc jar.

But we also publish the actual sources of the API module since we are open source, and most (all?) IDEs will auto-pull those and cross-link everything up and let you just open things and look. Which is 100 times more useful than javadoc and the primary reason why I haven't actually looked at anyone's javadoc in ages.

api-2.0.0-javadoc.zip

Learning (optional, can help others)

I'd almost forgotten that javadoc existed, but then I don't work much with closed-source products.

Checklist

Please, go through these checks before submitting the PR.

  • You have a descriptive commit message with a short title (first line, max 50 chars).
  • You have commented your code, particularly in hard-to-understand areas
  • You have performed a self-review of your own code
  • UI changes: include screenshots of all affected screens (in particular showing any new or changed strings)
  • UI Changes: You have tested your change using the Google Accessibility Scanner

Copy link
Member

@david-allison david-allison left a comment

Choose a reason for hiding this comment

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

I approve 3808c7c, but it feels like this PR needs a rebase before it goes in

Since moving to jitpack for API distribution we have not used dokka,
but it was still in our dependencies list
@mikehardy
Copy link
Member Author

yeah the other dependency-updates traffic blew this up

I just squashed dependency-updates to main
then I force-pushed dependency-updates after a reset --hard from main (so they were in sync post-squash)
then I took this branch and dropped all the single-commit dependency-updates before rebasing it from the newly-pushed dependency-updates with the squash

then I pushed that, so should be sparkly clean

@mikehardy mikehardy added the dependencies used for automated dependency PRs label Dec 18, 2024
@david-allison david-allison added the Pending Merge Things with approval that are waiting future merge (e.g. targets a future release, CI wait, etc) label Dec 18, 2024
@david-allison david-allison merged commit 6faa37c into ankidroid:dependency-updates Dec 18, 2024
9 checks passed
@github-actions github-actions bot added this to the 2.21 release milestone Dec 18, 2024
@github-actions github-actions bot removed the Pending Merge Things with approval that are waiting future merge (e.g. targets a future release, CI wait, etc) label Dec 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies used for automated dependency PRs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants