TeamNewPipe / TeamNewPipe/NewPipeExtractor

Add JDoc checks to PR pipeline

Open
#1,357 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement good first issue meta
Dominant language
Java
Stars
2k
Forks
602
Avg merge
3d 6h
Merged PRs (30d)
6

Description

Checklist
  • I am aware that this issue is being opened for the NewPipe Extractor, NOT the app, and my feature request will be dismissed otherwise.
  • I made sure that there are no existing issues - open or closed - which I could contribute my information to.
  • I have taken the time to fill in all the required details. I understand that the feature request will be dismissed otherwise.
  • This issue contains only one feature request.
  • I have read and understood the contribution guidelines.
Feature description

Check javadoc as part of the CI / PR pipeline to detect faulty docs before adding them to the dev branch.

Why do you want this feature?

Sometimes wrong JDoc is introduced in PRs. Format that is not accepted by the aggregatedJavadocs task lets the automated publishing of the docs fail which has been repeatedly happened after publishing a new version.

Additional information

An example PR fixing JDoc issues is #1356

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the CI/PR pipeline configuration and the aggregatedJavadocs task mentioned in the issue. Review PR #1356 for an example of the Javadoc problems this should catch. Done means pull requests check Javadoc before changes reach the dev branch and automated documentation publishing no longer fails because of faulty docs.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
ci-cd, documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.