Skip to content

chore(linter): fix linter issue in api and cmd package#5413

Merged
Skarlso merged 13 commits intoexternal-secrets:mainfrom
Lumexralph:olumide/configure-revive-linter-apis
Oct 24, 2025
Merged

chore(linter): fix linter issue in api and cmd package#5413
Skarlso merged 13 commits intoexternal-secrets:mainfrom
Lumexralph:olumide/configure-revive-linter-apis

Conversation

@Lumexralph
Copy link
Copy Markdown
Contributor

@Lumexralph Lumexralph commented Oct 5, 2025

Problem Statement

According to this PR #3396 was implemented, the revive linter wasn't configured because it had loads of issues to be fixed. This PR configures the revive linter and fixes all the issues raised by the linter.

Related Issue

Fixes #3397

Proposed Changes

Fix all the issues raised by the linter so that we can configure the revive linter. It focuses on fixes the lint issues in the apis and cmd package.

Format

Please ensure that your PR follows the following format for the title:

feat(scope): add new feature
fix(scope): fix bug
docs(scope): update documentation
chore(scope): update build tool or dependencies
ref(scope): refactor code
clean(scope): provider cleanup
test(scope): add tests
perf(scope): improve performance
desig(scope): improve design

Where scope is optionally one of:

  • charts
  • release
  • testing
  • security
  • templating

Checklist

  • I have read the contribution guidelines
  • All commits are signed with git commit --signoff
  • My changes have reasonable test coverage
  • All tests pass with make test
  • I ensured my PR is ready for review with make reviewable

@Lumexralph
chore(linter): fix linter issue in api and cmd package
1818441 
Signed-off-by: Olumide Ogundele <olumideralph@gmail.com>
@github-actions github-actions bot added area/linter kind/chore Categorizes Pull Requests for chore activities (like bumping versions) size/l labels Oct 5, 2025
@Lumexralph Lumexralph mentioned this pull request Oct 5, 2025
Closed
@Skarlso
Copy link
Copy Markdown
Contributor

Skarlso commented Oct 8, 2025

@Lumexralph Ugh, do you know why there might be so much duplication all of a sudden?

@moolen
Copy link
Copy Markdown
Member

moolen commented Oct 8, 2025

don't think that duplication means a lot in this context. It complains about comments being duplicated. Sentences in comments follow a similar structure, e.g. <Method> return <thing> of the SecretStore.

@Lumexralph
Copy link
Copy Markdown
Contributor Author

Lumexralph commented Oct 9, 2025

@Skarlso I have no idea. I would have expected this to be the code but will give it a closer look.

@Lumexralph
Copy link
Copy Markdown
Contributor Author

Lumexralph commented Oct 9, 2025

@Skarlso I have looked at the reported duplications, and as @moolen said, it's referencing the godoc comments. So, looks like a false positive. Is there a way we can configure it to ignore godoc comments?

@Skarlso
Copy link
Copy Markdown
Contributor

Skarlso commented Oct 9, 2025

Okay fine by me.

@Lumexralph
configure sonarqube to ignore godoc comments as duplicates
55e361c 
Signed-off-by: Olumide Ogundele <olumideralph@gmail.com>
@Lumexralph
update sonarqube config
2249eaf 
Signed-off-by: Olumide Ogundele <olumideralph@gmail.com>
@Lumexralph
update sonarqube config
62466d6 
Signed-off-by: Olumide Ogundele <olumideralph@gmail.com>
@Lumexralph
update sonarqube config
5767dcb 
Signed-off-by: Olumide Ogundele <olumideralph@gmail.com>
@Lumexralph
update sonarqube config
ff50c36 
Signed-off-by: Olumide Ogundele <olumideralph@gmail.com>
@Lumexralph
update sonarqube config
234318c 
Signed-off-by: Olumide Ogundele <olumideralph@gmail.com>
@Lumexralph
update sonarqube config
568aff5 
Signed-off-by: Olumide Ogundele <olumideralph@gmail.com>
@Lumexralph
Copy link
Copy Markdown
Contributor Author

Lumexralph commented Oct 9, 2025

@Skarlso @moolen, I don't know when sonarqube was configured, but I guess that since the new code added comments to the api packages, it detected them as new code and flagged them as duplicates, which is inevitable since they are api versions.

I excluded the packages from sonarqube, but if you have other suggestions, I'm happy to consider them.

@Skarlso
Copy link
Copy Markdown
Contributor

Skarlso commented Oct 10, 2025

Should be alright.

@Lumexralph
update the api docs
d0df8a4 
Signed-off-by: Olumide Ogundele <olumideralph@gmail.com>
@github-actions github-actions bot added the kind/documentation Categorizes issue or PR as related to documentation. label Oct 12, 2025
@Lumexralph
Copy link
Copy Markdown
Contributor Author

Lumexralph commented Oct 12, 2025

Hi @Skarlso, any chance I can get this PR in so that I can finally add the PR for configuring the revive linter?

@Skarlso
Copy link
Copy Markdown
Contributor

Skarlso commented Oct 14, 2025

Yes, I'm trying. :D I just didn't have the time yet.

@Skarlso
Copy link
Copy Markdown
Contributor

Skarlso commented Oct 17, 2025

Okay, this looks right. Nothing is deleted this time. :D

@Skarlso
Copy link
Copy Markdown
Contributor

Skarlso commented Oct 17, 2025

/ok-to-test sha=232ad44e5d8e25b860c35c50088827bd84147295

@eso-service-account-app
Copy link
Copy Markdown
Contributor

eso-service-account-app bot commented Oct 17, 2025

[Bot] - ✅ e2e for 232ad44e5d8e25b860c35c50088827bd84147295 passed

@gusfcarvalho
Copy link
Copy Markdown
Member

gusfcarvalho commented Oct 17, 2025

Glanced at it - LGTM.

@gusfcarvalho
Copy link
Copy Markdown
Member

gusfcarvalho commented Oct 17, 2025

Will take another pass when I have more energy / focus to go over so many changes 😅

@Lumexralph
Copy link
Copy Markdown
Contributor Author

Lumexralph commented Oct 20, 2025 •
edited
Loading

would have to wait before getting the last PR in because that'll configure the linter

@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Oct 23, 2025

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

github-advanced-security[bot]
github-advanced-security bot found potential problems Oct 23, 2025
View reviewed changes
@Skarlso Skarlso merged commit 6f411f5 into external-secrets:main Oct 24, 2025
30 checks passed
SamuelMolling pushed a commit to SamuelMolling/external-secrets that referenced this pull request Oct 24, 2025
@Lumexralph @Skarlso @SamuelMolling
chore(linter): fix linter issue in api and cmd package (external-…
b0c40a5 
…secrets#5413)

* chore(linter): fix linter issue in api and cmd package

Signed-off-by: Olumide Ogundele <olumideralph@gmail.com>

* configure sonarqube to ignore godoc comments as duplicates

Signed-off-by: Olumide Ogundele <olumideralph@gmail.com>

* update sonarqube config

Signed-off-by: Olumide Ogundele <olumideralph@gmail.com>

* update sonarqube config

Signed-off-by: Olumide Ogundele <olumideralph@gmail.com>

* update sonarqube config

Signed-off-by: Olumide Ogundele <olumideralph@gmail.com>

* update sonarqube config

Signed-off-by: Olumide Ogundele <olumideralph@gmail.com>

* update sonarqube config

Signed-off-by: Olumide Ogundele <olumideralph@gmail.com>

* update sonarqube config

Signed-off-by: Olumide Ogundele <olumideralph@gmail.com>

* update the api docs

Signed-off-by: Olumide Ogundele <olumideralph@gmail.com>

---------

Signed-off-by: Olumide Ogundele <olumideralph@gmail.com>
Co-authored-by: Gergely Brautigam <skarlso777@gmail.com>
Signed-off-by: Samuel Molling <samuelmolling@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@gusfcarvalho gusfcarvalho gusfcarvalho approved these changes

Assignees

No one assigned

Labels

area/linter kind/chore Categorizes Pull Requests for chore activities (like bumping versions) kind/documentation Categorizes issue or PR as related to documentation. size/l

Projects

External Secrets
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Configure revive properly

5 participants

@Lumexralph @Skarlso @moolen @gusfcarvalho @github-advanced-security