Skip to content

github-typescript

Actions
Run github-script using typescript
v7
Latest
Star (10)

Tags

 (1)

github-typescript

⚠️ Note that this action currently only supports running on linux x64 runners.

Using actions/github-script but missing typescript?

Enter github-typescript! A wrapper that will quickly transpile your TypeScript and execute it using github-script.

Usage example, create a *.ts or *.mts file in your and pass it in using script-file. This will cause github-typescript to transpile to JS this and execute it using github-script like.

- uses: flydiverny/github-typescript@v1
  env:
    INPUT_SOMETHING: "Nice demo run"
  with:
    script-file: .github/workflows/script.mts
    # (...) all other inputs supported by github-script@v6 will be passed thru

If you want to return a value you can export a default export and github-typescript will automatically run it for you. The arguments to the default export below are also available as globals, like it is for inline github-scripts.

export default async ({
  require,
  __original_require__,
  github,
  context,
  core,
  exec,
  glob,
  io,
  fetch,
}) => {
  // My code here
};

github-typescript is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

Run github-script using typescript
v7
Latest

Tags

 (1)

github-typescript is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.