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

chore: Update pnpx commands to pnpm dlx #511

Merged
merged 1 commit into from
Oct 25, 2024

Conversation

tharikashree
Copy link
Contributor

@tharikashree tharikashree commented Oct 24, 2024

User description

Description

Give a summary of the change that you have made

changed the pnpx commands to pnpm dlx in the specified files.

Fixes #510

Screenshots of relevant screens

image
image

Developer's checklist

  • My PR follows the style guidelines of this project
  • I have performed a self-check on my work

If changes are made in the code:

  • I have followed the coding guidelines
  • My changes in code generate no new warnings
  • My changes are breaking another fix/feature of the project
  • I have added test cases to show that my feature works
  • I have added relevant screenshots in my PR
  • There are no UI/UX issues

Documentation Update

  • This PR requires an update to the documentation at docs.keyshade.xyz
  • I have made the necessary updates to the documentation, or no documentation changes are required.

PR Type

enhancement


Description

  • Replaced pnpx with pnpm dlx in the GitHub Actions workflow for the semantic-release command.
  • Updated several npm scripts in apps/api/package.json to use pnpm dlx instead of pnpx, including commands for Prisma migrations and validation.

Changes walkthrough 📝

Relevant files
Enhancement
release.yml
Update semantic-release command to use pnpm dlx                   

.github/workflows/release.yml

  • Replaced pnpx with pnpm dlx for semantic-release command.
+1/-1     
package.json
Update npm scripts to use pnpm dlx                                             

apps/api/package.json

  • Replaced pnpx with pnpm dlx in several npm scripts.
  • Updated commands for Prisma migrations and validation.
  • +4/-4     

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    🎫 Ticket compliance analysis ✅

    510 - Fully compliant

    Fully compliant requirements:

    • Update commands using pnpx to use pnpm dlx instead
    • Make changes in .github/workflows/release.yml
    • Make changes in apps/api/package.json
    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ No major issues detected

    Copy link
    Contributor

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    Best practice
    Specify the version of the semantic-release package to ensure consistency

    Consider specifying the version of semantic-release to ensure consistent behavior
    across different environments.

    .github/workflows/release.yml [33]

    -run: pnpm dlx semantic-release
    +run: pnpm dlx semantic-release@21.0.5
    • Apply this suggestion
    Suggestion importance[1-10]: 7

    Why: Specifying a version for semantic-release can help ensure consistent behavior across different environments, reducing the risk of unexpected changes due to updates. This is a good practice for maintaining stability in CI/CD workflows.

    7
    Maintainability
    Standardize the structure of Prisma-related npm scripts for better consistency and maintainability

    Consider using a consistent command structure for all Prisma-related scripts by
    moving the environment file specification to the beginning of each command.

    apps/api/package.json [12-17]

    -"db:generate-types": "pnpm dlx prisma generate --schema=src/prisma/schema.prisma",
    +"db:generate-types": "pnpm dlx dotenv-cli -e ../../.env -- pnpm dlx prisma generate --schema=src/prisma/schema.prisma",
     "db:generate-migrations": "pnpm dlx dotenv-cli -e ../../.env -- pnpm dlx prisma migrate dev --create-only --skip-seed --schema=src/prisma/schema.prisma",
     "db:deploy-migrations": "pnpm dlx dotenv-cli -e ../../.env -- pnpm dlx prisma migrate deploy --schema=src/prisma/schema.prisma",
     "db:validate": "pnpm dlx dotenv-cli -e ../../.env -- pnpm dlx prisma validate --schema=src/prisma/schema.prisma",
    -"db:format": "pnpm dlx prisma format --schema=src/prisma/schema.prisma",
    +"db:format": "pnpm dlx dotenv-cli -e ../../.env -- pnpm dlx prisma format --schema=src/prisma/schema.prisma",
     "db:reset": "pnpm dlx dotenv-cli -e ../../.env -- pnpm dlx prisma migrate reset --force --schema=src/prisma/schema.prisma",
    • Apply this suggestion
    Suggestion importance[1-10]: 6

    Why: The suggestion to standardize the command structure by consistently specifying the environment file can improve readability and maintainability. However, it offers a minor improvement as the existing commands are already functional.

    6

    💡 Need additional feedback ? start a PR chat

    Copy link
    Member

    @rajdip-b rajdip-b left a comment

    Choose a reason for hiding this comment

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

    LGTM

    @rajdip-b rajdip-b changed the title chore: update pnpx commands to pnpm dlx chore: Update pnpx commands to pnpm dlx Oct 25, 2024
    @rajdip-b rajdip-b merged commit 534a231 into keyshade-xyz:develop Oct 25, 2024
    8 checks passed
    rajdip-b pushed a commit that referenced this pull request Nov 5, 2024
    ## [2.7.0](v2.6.0...v2.7.0) (2024-11-05)
    
    ### 🚀 Features
    
    * **cli:** Add functionality to operate on Variables ([#514](#514)) ([32d93e6](32d93e6))
    * **platform:** Create ui link for resend otp ([#489](#489)) ([46eb5c5](46eb5c5))
    
    ### 🐛 Bug Fixes
    
    * **api,api-client:** Add environmentSlug in multiple places across the [secure] module ([#509](#509)) ([ee58f07](ee58f07))
    * **cli:** Removed unnecessary console log in [secure]s ([#515](#515)) ([9403cc4](9403cc4))
    
    ### 🔧 Miscellaneous Chores
    
    * Fixed lint issues ([835397a](835397a))
    * Minor housekeeping ([922bf31](922bf31))
    * Update eslint ([c583718](c583718))
    * Update eslint ([7c0c596](7c0c596))
    * Update pnpx commands to pnpm dlx ([#511](#511)) ([534a231](534a231))
    @rajdip-b
    Copy link
    Member

    rajdip-b commented Nov 5, 2024

    🎉 This PR is included in version 2.7.0 🎉

    The release is available on GitHub release

    Your semantic-release bot 📦🚀

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

    Successfully merging this pull request may close these issues.

    Replace pnpx with pnpm dlx
    2 participants