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.

Sign up for GitHub

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

Jump to bottom

Add linter for the samples scaffolded under docs #4445

Open
camilamacedo86 opened this issue Dec 27, 2024 · 3 comments · May be fixed by #4464
Open

Add linter for the samples scaffolded under docs #4445

camilamacedo86 opened this issue Dec 27, 2024 · 3 comments · May be fixed by #4464
Assignees
@jongwooo
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/feature Categorizes issue or PR as related to a new feature. testing

Comments

@camilamacedo86
Copy link
Member

What do you want to happen?

Currently, the samples scaffolded under the docs directory do not have any linting process to ensure consistency and adherence to best practices. This issue proposes adding a linter to verify the quality of the following samples:

  • docs/book/src/cronjob-tutorial/testdata/project
  • docs/book/src/getting-started/testdata/project
  • docs/book/src/multiversion-tutorial/testdata/project

We should create an action to lint them as we have for the samples under testdata
See: https://github.com/kubernetes-sigs/kubebuilder/blob/master/.github/workflows/lint-sample.yml

in this task, we need to create the action and fix any linter issue found to ensure that it pass in the CI

Extra Labels

No response
@camilamacedo86 camilamacedo86 added the kind/feature Categorizes issue or PR as related to a new feature. label Dec 27, 2024
@camilamacedo86 camilamacedo86 mentioned this issue Dec 27, 2024
Merged
@camilamacedo86 camilamacedo86 added help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. testing labels Dec 27, 2024
@jongwooo
Copy link
Member

/assign

@jongwooo
Copy link
Member

Hi @camilamacedo86

I have a question regarding the task of adding a linter for the samples under the docs directory. I noticed in the reference workflow (lint-sample.yml) that the matrix includes paths for different samples. Would it be possible to simply add the new paths to the existing matrix in the configuration, rather than creating a completely new action?

kubebuilder/.github/workflows/lint-sample.yml

Lines 15 to 20 in 980fb71

matrix:
folder: [
"testdata/project-v4",
"testdata/project-v4-with-plugins",
"testdata/project-v4-multigroup"
]

I just want to confirm if this approach is acceptable before proceeding.

Thank you for your help!

@camilamacedo86
Copy link
Member Author

camilamacedo86 commented Dec 31, 2024 •
edited
Loading

Hi @jongwooo

Yes, we can just add the path for the docs samples on this one
The most important is to fix the issues found (if any) in the same PR/commit

We should not have more than 1 commit for this PR

@jongwooo jongwooo linked a pull request Jan 1, 2025 that will close this issue
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jongwooo jongwooo

Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/feature Categorizes issue or PR as related to a new feature. testing
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

🌱 (ci): Add linter for the samples scaffolded under docs jongwooo/kubebuilder
2 participants
@camilamacedo86 @jongwooo