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

Linters: remove godox and add exclude rule for forbidigo in mage files #31433

Merged
merged 1 commit into from
Apr 27, 2022

Conversation

kvch
Copy link
Contributor

@kvch kvch commented Apr 27, 2022

What does this PR do?

This PR adjusts the linter configuration, so we get less noise. The two impacted linters are godox and forbidigo.

Why is it important?

godox is used to track down TODO, FIXME, etc. comments. Instead developers should open tickets in their issue trackers. Beats code is full of such comments without actual issues to back them up. I think the comments are valuable when we are debugging. But let's be honest, we are not going to fix all of the problems. Also, we cannot really open a valuable follow-up issue for such comments because we lack the required context.

forbidigo forbids us to use fmt.Print*. In the product code it makes sense. However, in mage we constantly print to stdout to give feedback to the developer. In mage targets and mage files, using fmt.Print* is the standard and should be valid.

Checklist

- [ ] My code follows the style guidelines of this project
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] I have made corresponding change to the default configuration files
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

@kvch kvch requested a review from a team as a code owner April 27, 2022 06:58
@kvch kvch requested review from belimawr and leehinman and removed request for a team April 27, 2022 06:58
@botelastic botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Apr 27, 2022
@kvch kvch added the Team:Elastic-Agent-Data-Plane Label for the Agent Data Plane team label Apr 27, 2022
@elasticmachine
Copy link
Collaborator

Pinging @elastic/elastic-agent-data-plane (Team:Elastic-Agent-Data-Plane)

@botelastic botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Apr 27, 2022
@mergify mergify bot assigned kvch Apr 27, 2022
@kvch kvch requested a review from cmacknz April 27, 2022 06:59
@elasticmachine
Copy link
Collaborator

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2022-04-27T06:58:54.482+0000

  • Duration: 79 min 2 sec

Test stats 🧪

Test Results
Failed 0
Passed 22319
Skipped 1935
Total 24254

💚 Flaky test report

Tests succeeded.

🤖 GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

  • /package : Generate the packages and run the E2E tests.

  • /beats-tester : Run the installation tests with beats-tester.

  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

@kvch kvch merged commit 4782290 into elastic:main Apr 27, 2022
kush-elastic pushed a commit to kush-elastic/beats that referenced this pull request May 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team:Elastic-Agent-Data-Plane Label for the Agent Data Plane team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants