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

Add husky to pre-lint any commits, remove unused imports #1851

Merged
merged 2 commits into from
Mar 26, 2024

Conversation

derek-ho
Copy link
Collaborator

@derek-ho derek-ho commented Mar 26, 2024

Description

Adds a rule to lint any commits prior to pushing. This should fix cases where work is pushed up but not linted, failing CI. TODO: should we add running tests here?

Category

[Enhancement, New feature, Bug fix, Test fix, Refactoring, Maintenance, Documentation]

Why these changes are required?

What is the old behavior before changes and new behavior after changes?

Linting was not done automatically and developer cycles were needed to remember to manually run that command

Issues Resolved

[List any issues this PR will resolve (Is this a backport? If so, please add backport PR # and/or commits #)]
Fix: #1805

Testing

[Please provide details of testing done: unit testing, integration testing and manual testing]

Check List

  • New functionality includes testing
  • New functionality has been documented
  • Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Derek Ho <dxho@amazon.com>
Signed-off-by: Derek Ho <dxho@amazon.com>
@derek-ho
Copy link
Collaborator Author

@cwperks this address this comment as well: #1824 (comment)

@derek-ho derek-ho added the backport 2.x backport to 2.x branch label Mar 26, 2024
Copy link

codecov bot commented Mar 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.04%. Comparing base (aa77c59) to head (cc38130).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1851   +/-   ##
=======================================
  Coverage   68.04%   68.04%           
=======================================
  Files          94       94           
  Lines        2422     2422           
  Branches      330      330           
=======================================
  Hits         1648     1648           
  Misses        696      696           
  Partials       78       78           

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

Copy link
Member

@cwperks cwperks left a comment

Choose a reason for hiding this comment

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

Thank you @derek-ho! This makes the commit process consistent with OSD core.

OSD Core has an issue filed around unused imports. If the issue is fixed in core, would those rules transitively apply to the security-dashboards-plugin?

@derek-ho
Copy link
Collaborator Author

Thank you @derek-ho! This makes the commit process consistent with OSD core.

OSD Core has an issue filed around unused imports. If the issue is fixed in core, would those rules transitively apply to the security-dashboards-plugin?

This PR is already making unused imports error the linting process by adding the "unused-imports" plugin to the eslintrc.js file - I didn't manually remove those imports, it was automatically done as part of the pre-commit hook.

@derek-ho derek-ho merged commit d82e129 into opensearch-project:main Mar 26, 2024
16 checks passed
@derek-ho derek-ho deleted the spring-cleaning branch March 26, 2024 20:08
@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-2.x 2.x
# Navigate to the new working tree
cd .worktrees/backport-2.x
# Create a new branch
git switch --create backport/backport-1851-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 d82e12924141922923045c4ce50cc49f4a5883c2
# Push it to GitHub
git push --set-upstream origin backport/backport-1851-to-2.x
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-1851-to-2.x.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.x backport to 2.x branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[FEATURE] Add yarn lint as a pre-commit hook
3 participants