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

Prevent npm usage #6742

Merged
merged 1 commit into from
Feb 6, 2024
Merged

Conversation

lucasfcnunes
Copy link
Member

@lucasfcnunes lucasfcnunes commented Feb 4, 2024

What type of PR is this?

  • Refactor
  • Feature
  • Bug Fix
  • New Query Runner (Data Source)
  • New Alert Destination
  • Other

Description

  • The project uses yarn as the package manager and the script runner, so we do not use npm for any tasks (except to install yarn globally).
  • Using npm may cause inconsistencies in the dependencies, the lock file, and the build process. This PR aims to guarantee this won't happen.
  • If you need to install a new package, use yarn add instead of npm install.
  • If you need to run a script, use yarn run instead of npm run.
  • If you need to update a package, use yarn upgrade instead of npm update.

How is this tested?

  • Unit tests (pytest, jest)
  • E2E Tests (Cypress)
  • Manually
  • N/A
  • npm install blocked (as expected)

Pasted image 20240204110713

  • npm install --global still works as expected

Pasted image 20240204191553

Pasted image 20240204192103

Related Tickets & Documents

Mobile & Desktop Screenshots/Recordings (if there are UI changes)

N/A

Signed-off-by: Lucas Fernando Cardoso Nunes <[email protected]>
@lucasfcnunes lucasfcnunes changed the title feat: avoid npm usage avoid npm usage Feb 4, 2024
Copy link

codecov bot commented Feb 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (49a5e74) 63.37% compared to head (2bb9446) 63.37%.
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #6742   +/-   ##
=======================================
  Coverage   63.37%   63.37%           
=======================================
  Files         162      162           
  Lines       13170    13170           
  Branches     1819     1819           
=======================================
  Hits         8347     8347           
  Misses       4532     4532           
  Partials      291      291           

@lucasfcnunes lucasfcnunes changed the title avoid npm usage Prevent npm usage Feb 4, 2024
Copy link
Contributor

@guidopetri guidopetri left a comment

Choose a reason for hiding this comment

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

Succinct explanation and very clear purpose to the PR, thanks so much for your contribution!

@guidopetri guidopetri merged commit a600921 into getredash:master Feb 6, 2024
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants