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

Discuss removing suppression for settersHaveSinceTag #1022

Open
stoyanK7 opened this issue Jul 31, 2023 · 3 comments
Open

Discuss removing suppression for settersHaveSinceTag #1022

stoyanK7 opened this issue Jul 31, 2023 · 3 comments
Assignees

Comments

@stoyanK7
Copy link
Contributor

stoyanK7 commented Jul 31, 2023

In checkstyle/checkstyle#13455 we add a MatchXPath check to ensure that all property setters have a @since property in their Javadoc. For example

/**
...
@since 1.1
*/
public final void setSomething() ..

In #1023 we add a suppression for all checks in this repository because the CI in checkstyle repo is failing
https://checkstyle.semaphoreci.com/jobs/b80149c4-f163-4908-a4ab-98a19bcb625e

ERROR] [checkstyle] [ERROR] /home/semaphore/checkstyle/.ci-temp/sevntu.checkstyle/sevntu-checks/src/main/java/com/github/sevntu/checkstyle/checks/annotation/ForbidAnnotationCheck.java:66:5: All property setters of a module should contain a @since tag. [[ERROR] /home/semaphore/checkstyle/.ci-temp/sevntu.checkstyle/sevntu-checks/config/ant-phase-verify.xml:116: Checkstyle failed: Got 115 errors and 0 warnings.] 01:07
[ERROR] [checkstyle] [ERROR] /home/semaphore/checkstyle/.ci-temp/sevntu.checkstyle/sevntu-checks/src/main/java/com/github/sevntu/checkstyle/checks/annotation/ForbidAnnotationCheck.java:79:5: All property setters of a module should contain a @since tag. [settersHaveSinceTag]
...
[ERROR] /home/semaphore/checkstyle/.ci-temp/sevntu.checkstyle/sevntu-checks/config/ant-phase-verify.xml:116: Checkstyle failed: Got 115 errors and 0 warnings.

I am not sure if we want to add those @sinces in this project or if it's possible. The purpose of this issue is to add an until ... on the line above the suppression of this check and discuss potentially removing it in the future

@nrmancuso
Copy link
Contributor

I think it is reasonable to add such tags to property setters anywhere really, let's see what others think.

@rnveach
Copy link
Contributor

rnveach commented Jul 31, 2023

I don't believe this repo has those things documented, so it will be regression hunting to identify all the versions to add. The custom branch I used referenced in the main repo's issue should be able to be used for this.

I am fine with this being done.

@romani
Copy link
Member

romani commented Aug 1, 2023

This repo don't need this metadata for now, if we have time in future we will do this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants