Getting “error TS2589” on GH Actions but works locally

If you are encountering the “error TS2589” while running your TypeScript code on GitHub Actions, but it works fine locally, don’t worry, you are not alone. This error typically occurs due to differences in the TypeScript compiler versions between your local environment and the GitHub Actions environment. In this blog post, we will explore a couple of solutions to resolve this issue.

Solution 1: Specify TypeScript Version in GitHub Actions Workflow

One way to fix the “error TS2589” on GitHub Actions is to explicitly specify the TypeScript version in your workflow file. This ensures that the same TypeScript version is used both locally and on GitHub Actions.

To specify the TypeScript version, you can add a step in your GitHub Actions workflow file before running the TypeScript compiler. Here’s an example:

name: Build and Test
on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

jobs:
  build:
    runs-on: ubuntu-latest
    
    steps:
      - name: Checkout code
        uses: actions/checkout@v2
      
      - name: Setup Node.js
        uses: actions/setup-node@v2
        with:
          node-version: 14

      - name: Install dependencies
        run: npm ci
      
      - name: Specify TypeScript version
        run: npm install typescript@4.4.3
      
      - name: Build
        run: npm run build
      
      - name: Test
        run: npm run test

In the above example, we added a step named “Specify TypeScript version” where we install the desired TypeScript version using npm. Replace “4.4.3” with the version you want to use.

Solution 2: Use TypeScript Version Manager

Another approach to ensure consistent TypeScript versions is by using a TypeScript version manager like “nvm” (Node Version Manager) or “volta”. These tools allow you to switch between different versions of TypeScript effortlessly.

If you don’t have nvm or volta installed, you can follow their respective installation guides:

• nvm Installation Guide
• volta Installation Guide

Once you have nvm or volta set up, you can specify the desired TypeScript version in your project’s configuration file (e.g., .nvmrc or .volta). Here’s an example:

4.4.3

After specifying the TypeScript version, you can run the following command to ensure that the correct version is used:

nvm use

Conclusion

Encountering the “error TS2589” on GitHub Actions while your code works locally can be frustrating. However, by following the solutions mentioned above, you can ensure consistent TypeScript versions and resolve this issue effectively.

Remember to either specify the TypeScript version in your GitHub Actions workflow or use a TypeScript version manager like nvm or volta. This will help you avoid compatibility issues and ensure a smooth development and deployment process.

We hope this blog post has helped you resolve the “error TS2589” on GitHub Actions. Happy coding!