Skip to content

chore: Move jobs from lint.yml to style.yml#14922

Merged
msugakov merged 4 commits intomasterfrom
misha/unify-lint-and-style
Apr 10, 2025
Merged

chore: Move jobs from lint.yml to style.yml#14922
msugakov merged 4 commits intomasterfrom
misha/unify-lint-and-style

Conversation

@msugakov
Copy link
Contributor

@msugakov msugakov commented Apr 8, 2025 •
edited
Loading

Description

While looking into #14827, I felt that I don't understand the reason why lint.yml is separate from style.yml and so in this PR I unify the two.

Unfortunately, the line history in lint.yml will likely be lost so here I reference its version before I touched it: https://github.com/stackrox/stackrox/blob/8dcfbe3cf20bf7b8730121db97663bd83a091156/.github/workflows/lint.yml

User-facing documentation

  • CHANGELOG is updated OR update is not needed
  • documentation PR is created and is linked above OR is not needed

Testing and quality

  • the change is production ready: the change is GA or otherwise the functionality is gated by a feature flag
  • CI results are inspected

Automated testing

No change.

How I validated my change

Looked into CI output.

Summary by Sourcery

Consolidate GitHub Actions workflow jobs from lint.yml into style.yml

CI:

  • Move GitHub Actions linting jobs including actionlint, shellcheck, and OpenShift CI linting from a separate workflow file to the existing style workflow

Chores:

  • Remove the standalone lint.yml workflow file and integrate its jobs into style.yml

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Apr 8, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request consolidates the GitHub Actions workflow jobs from lint.yml into style.yml. This change simplifies the workflow configuration by removing the separate lint.yml file and integrating its jobs into the existing style.yml workflow.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Consolidated GitHub Actions workflow jobs from lint.yml into style.yml.
  • Moved GitHub Actions linting job.
  • Moved Shellcheck job.
  • Moved OpenShift CI linting job.
  • Removed the lint.yml file.
 .github/workflows/style.yaml
.github/workflows/lint.yml
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@msugakov msugakov marked this pull request as draft April 8, 2025 17:26
sourcery-ai[bot]
sourcery-ai bot reviewed Apr 8, 2025
View reviewed changes
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @msugakov - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider whether the jobs being moved should be reordered in the destination file.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟡 Security: 1 issue found
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@msugakov msugakov force-pushed the misha/unify-lint-and-style branch from 1ba7a00 to 27bf10a Compare April 8, 2025 17:47
@rhacs-bot
Copy link
Contributor

rhacs-bot commented Apr 8, 2025 •
edited
Loading

Images are ready for the commit at c8470bb.

To use with deploy scripts, first export MAIN_IMAGE_TAG=4.8.x-444-gc8470bb19a.

@rhacs-bot
Copy link
Contributor

rhacs-bot commented Apr 8, 2025

Images are ready for the commit at 27bf10a.

To use with deploy scripts, first export MAIN_IMAGE_TAG=4.8.x-364-g8ab7d9ec06.

@codecov
Copy link

codecov bot commented Apr 8, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 48.96%. Comparing base (7ea6887) to head (c8470bb).
Report is 5 commits behind head on master.

Additional details and impacted files 
@@            Coverage Diff             @@
##           master   #14922      +/-   ##
==========================================
- Coverage   48.96%   48.96%   -0.01%     
==========================================
  Files        2550     2550              
  Lines      187230   187230              
==========================================
- Hits        91679    91677       -2     
- Misses      88300    88302       +2     
  Partials     7251     7251
Flag Coverage Δ
go-unit-tests 48.96% <ø> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Base automatically changed from misha/reshuffle-konflux-images-checks to master April 9, 2025 12:01
msugakov added 4 commits April 9, 2025 14:12
@msugakov
Copy jobs from lint.yml to style.yml
2e6824e 
Only used copy and paste, no other changes.
@msugakov
Add old new jobs to slack-on-style-failure
cd54702
@msugakov
Delete lint.yml as redundant
692f882
@msugakov
Pin commit for getting download-actionlint.bash
c8470bb 
so that we can be sure the content remains the same I've seen in
case of repo takeover.

This change was suggested by sourcery-ai.
@msugakov msugakov force-pushed the misha/unify-lint-and-style branch from 27bf10a to c8470bb Compare April 9, 2025 12:13
@msugakov msugakov marked this pull request as ready for review April 9, 2025 14:08
@msugakov msugakov requested a review from tommartensen April 9, 2025 14:08
davdhacs
davdhacs approved these changes Apr 9, 2025
View reviewed changes
Copy link
Contributor

@davdhacs davdhacs left a comment •
edited
Loading

Choose a reason for hiding this comment

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

lgtm

I would argue that "style" checks are a subset under "lint" (or "code analysis"?), but "style" is clear enough for engineers to find.

@msugakov
Copy link
Contributor Author

msugakov commented Apr 9, 2025

style.yml won for me because it has more lines and seems to be more active than lint.yml. That's why I decided to sacrifice the line history of lint.yml but not style.yml.
I can follow-up with a PR that renames style.yml -> lint.yml unless you think this might be an overkill.

@msugakov msugakov merged commit 210ae95 into master Apr 10, 2025
87 checks passed
@msugakov msugakov deleted the misha/unify-lint-and-style branch April 10, 2025 08:18
@msugakov msugakov mentioned this pull request Apr 10, 2025
Merged
4 tasks
@davdhacs
Copy link
Contributor

davdhacs commented Apr 10, 2025

style.yml won for me because it has more lines and seems to be more active than lint.yml. That's why I decided to sacrifice the line history of lint.yml but not style.yml. I can follow-up with a PR that renames style.yml -> lint.yml unless you think this might be an overkill.

I understand. And I think renaming after this would be overkill.

janisz pushed a commit that referenced this pull request Apr 14, 2025
@msugakov @janisz
chore: Move jobs from lint.yml to style.yml (#14922)
5797071
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

@tommartensen tommartensen tommartensen approved these changes

@davdhacs davdhacs davdhacs approved these changes

Assignees

No one assigned

Labels

area/ci

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@msugakov @rhacs-bot @davdhacs @tommartensen