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

Integrate linters in kubeapps-general workflow #5606

Merged
merged 25 commits into from Nov 4, 2022
Merged

Integrate linters in kubeapps-general workflow #5606

merged 25 commits into from Nov 4, 2022

Conversation

beni0888
Copy link
Collaborator

@beni0888 beni0888 commented Nov 3, 2022 •
edited

Signed-off-by: Jesús Benito Calzada bjesus@vmware.com

Description of the change

We have several GHA workflows doing several small tasks that would be better integrated into the Kubeapps general workflow. Some of those workflows/jobs are the linters: golangci-lint and check-license-headers. With that in mind, this PR comprises the following changes:

  • Add a reusable workflow that contains all the existent linter jobs: golang-lint, check-license-headers and CodeQL-analyze.
  • Remove the individual workflows for the linters mentioned above, except for CodeQL, for which we have created its own reusable workflow, so we can call it from the new linters reusable workflow and from a new codeql-scheduled.yml workflow that's executed on scheduled as has been doing so far.
  • Add a new linter for yaml files (yamllint) to the linters workflow.
  • Integrate the new linters reusable workflow into the kubeapps-general workflow, so the linters are part of the general pipeline.
  • Fix most of the issues detected by the new linter for yaml files.

Benefits

  • Reduce the number of workflows and jobs scattered through different GHA files.
  • Have a more consistent kubeapps-general workflow, that includes (almost) all the tasks that make sense for the SDLC process.
  • Keep the yaml files of the project consistent according to a defined set of rules.

Possible drawbacks

  • The kubeapps-general workflow gets bigger and takes even more responsibilities.
  • Maybe some undetected side effects could appear in the future as a result of the fixed yaml files??

Applicable issues

Additional information

@beni0888
Integrate linters in kubeapps-general workflow
e161d86 
Signed-off-by: Jesús Benito Calzada <bjesus@vmware.com>
@netlify
Copy link

netlify bot commented Nov 3, 2022 •
edited

✅ Deploy Preview for kubeapps-dev canceled.

Built without sensitive environment variables

Name Link
🔨 Latest commit 7503913
🔍 Latest deploy log https://app.netlify.com/sites/kubeapps-dev/deploys/63650606e1647600075212cb

@beni0888 beni0888 self-assigned this Nov 3, 2022
@beni0888 beni0888 added component/ci Issue related to kubeapps ci system kind/enhancement An issue that reports an enhancement for an implemented feature github_actions Pull requests that update GitHub Actions code labels Nov 3, 2022
@beni0888 beni0888 added this to the Migrate CI to GitHub Actions milestone Nov 3, 2022
@beni0888
Extract linters to a reusable workflow
5ea8a10 
Signed-off-by: Jesús Benito Calzada <bjesus@vmware.com>
@beni0888
Extract linters to a reusable workflow
af4b3b9 
Signed-off-by: Jesús Benito Calzada <bjesus@vmware.com>
@beni0888
Extract linters to a reusable workflow
e293dbb 
Signed-off-by: Jesús Benito Calzada <bjesus@vmware.com>
@beni0888
Extract linters to a reusable workflow
47778d8 
Signed-off-by: Jesús Benito Calzada <bjesus@vmware.com>
@beni0888 beni0888 marked this pull request as ready for review November 3, 2022 11:53
antgamdia
antgamdia approved these changes Nov 3, 2022
View reviewed changes
Copy link
Contributor

@antgamdia antgamdia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome, much simpler than having a workflow per linter!

Please, mind the EOF new line 😅

image

@beni0888
Add CodeQL to linters
57e2829 
Signed-off-by: Jesús Benito Calzada <bjesus@vmware.com>
@beni0888
Copy link
Collaborator Author

beni0888 commented Nov 3, 2022

Awesome, much simpler than having a workflow per linter!

Please, mind the EOF new line 😅

image

ouch!! 😓 That dog always bites me... I think we need a linter for that 😉

@beni0888
Add EOF newline
a42a8f6 
Signed-off-by: Jesús Benito Calzada <bjesus@vmware.com>
@beni0888
Add yaml linter
d0d54f8 
Signed-off-by: Jesús Benito Calzada <bjesus@vmware.com>
@beni0888
Add yamllint config
5dd8e90 
Signed-off-by: Jesús Benito Calzada <bjesus@vmware.com>
@beni0888
Disable line-length rule
3625b7c 
Signed-off-by: Jesús Benito Calzada <bjesus@vmware.com>
@beni0888
Fix yamllint issues
61ec72a 
Signed-off-by: Jesús Benito Calzada <bjesus@vmware.com>
@beni0888
Ignore path
e12676f 
Signed-off-by: Jesús Benito Calzada <bjesus@vmware.com>
@beni0888
Fix indentation issues
d984ea4 
Signed-off-by: Jesús Benito Calzada <bjesus@vmware.com>
@beni0888
Fix yamllint issues
f1522ce 
Signed-off-by: Jesús Benito Calzada <bjesus@vmware.com>
@beni0888
Config yamllint
dbb625a 
Signed-off-by: Jesús Benito Calzada <bjesus@vmware.com>
@beni0888
Fix too many spaces after colon
6ac6ce1 
Signed-off-by: Jesús Benito Calzada <bjesus@vmware.com>
@beni0888
Fix wrong indentation
eb09ab3 
Signed-off-by: Jesús Benito Calzada <bjesus@vmware.com>
@beni0888
Fix yamllint issues
f83f3aa 
Signed-off-by: Jesús Benito Calzada <bjesus@vmware.com>
absoludity
absoludity approved these changes Nov 4, 2022
View reviewed changes
Copy link
Contributor

@absoludity absoludity left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, thanks for the attention to detail :)

@beni0888
Restore yaml file that makes test to fail, ignore in yaml lint
67a7d1a 
Signed-off-by: Jesús Benito Calzada <bjesus@vmware.com>
@beni0888
Tune yamllint for truthy not to check keys
49cca50 
Signed-off-by: Jesús Benito Calzada <bjesus@vmware.com>
@beni0888
Ignore file in yamllint
4bc5b08 
Signed-off-by: Jesús Benito Calzada <bjesus@vmware.com>
@beni0888
Disable yamllint rules with file annotations
ebfdbee 
Signed-off-by: Jesús Benito Calzada <bjesus@vmware.com>
@beni0888
Remove warning-level configuration for trailing whitespaces
bedf3a1 
Signed-off-by: Jesús Benito Calzada <bjesus@vmware.com>
@beni0888
Fine tune yamllint config
b66968a 
Signed-off-by: Jesús Benito Calzada <bjesus@vmware.com>
@beni0888
Remove changes from charts and ignore them in yamllint
7503913 
Signed-off-by: Jesús Benito Calzada <bjesus@vmware.com>
@beni0888 beni0888 merged commit 3deb413 into vmware-tanzu:main Nov 4, 2022
@beni0888 beni0888 deleted the integrate-golangci-lint branch November 4, 2022 14:40
@beni0888 beni0888 mentioned this pull request Nov 7, 2022
Closed
30 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@absoludity absoludity absoludity approved these changes

@antgamdia antgamdia antgamdia approved these changes

Assignees

@beni0888 beni0888

Labels
cla-not-required component/ci Issue related to kubeapps ci system github_actions Pull requests that update GitHub Actions code kind/enhancement An issue that reports an enhancement for an implemented feature
Projects
Kubeapps
Status: ✅ Done
Milestone
Migrate CI to GitHub Actions
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@beni0888 @absoludity @antgamdia @vmwclabot