usermaven / usermaven-js

Usermaven provides instant actionable analytics to grow your SaaS business.
MIT License
1 stars 2 forks source link

CICD: adding yarn typescript #90

Closed amna0125 closed 1 month ago

amna0125 commented 1 month ago

PR Type

enhancement, configuration changes


Description


Changes walkthrough ๐Ÿ“

Relevant files
Configuration changes
cd-develop.yml
Add TypeScript installation step to CD workflow                   

.github/workflows/cd-develop.yml
  • Added a step to install the latest version of TypeScript using Yarn.
  • +3/-0     
    cd-master.yml
    Add TypeScript installation step to CD workflow                   

    .github/workflows/cd-master.yml
  • Added a step to install the latest version of TypeScript using Yarn.
  • +3/-0     

    ๐Ÿ’ก PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    github-actions[bot] commented 1 month ago

    PR Reviewer Guide ๐Ÿ”

    ๐Ÿ… Score: 85
    ๐Ÿงช No relevant tests
    ๐Ÿ”’ No security concerns identified
    โšก Key issues to review

    Performance Issue
    Installing TypeScript as a regular dependency in a CI/CD pipeline can slow down the build process due to unnecessary package installation on each run. Performance Issue
    Installing TypeScript as a regular dependency in a CI/CD pipeline can slow down the build process due to unnecessary package installation on each run.
    Code feedback:
    relevant file.github/workflows/cd-develop.yml
    suggestion       Consider using 'yarn global add typescript' instead of 'yarn add typescript@latest' to avoid adding TypeScript as a dependency in every build, which can save time and resources. [important]
    relevant linerun: yarn add typescript@latest

    relevant file.github/workflows/cd-master.yml
    suggestion       Consider using 'yarn global add typescript' instead of 'yarn add typescript@latest' to avoid adding TypeScript as a dependency in every build, which can save time and resources. [important]
    relevant linerun: yarn add typescript@latest

    github-actions[bot] commented 1 month ago

    PR Code Suggestions โœจ

    CategorySuggestion                                                                                                                                    Score
    Best practice
    Pin the version of TypeScript to ensure consistent builds ___ **Consider pinning the version of TypeScript to ensure consistent builds and avoid
    potential breaking changes introduced in new versions. Using a specific version
    number instead of 'latest' can help maintain the stability of your project.** [.github/workflows/cd-develop.yml [38]](https://github.com/usermaven/usermaven-js/pull/90/files#diff-4f501c9619899525498594b20a28ab29c8547673701f9285b403540c8c09762fR38-R38) ```diff - name: add yarn typescript - run: yarn add typescript@latest + run: yarn add typescript@4.5.4 ```
    Suggestion importance[1-10]: 9 Why: Pinning the TypeScript version helps ensure consistent builds and avoids potential issues from breaking changes in new versions. This is a best practice for maintaining project stability.
    9