Usage

Important

As we useconditional exports, you will need to adapt yourtsconfig.json by setting"moduleResolution": "node16", "module": "node16".

See the TypeScript docs onpackage.json "exports".
See thishelpful guide on transitioning to ESM from@sindresorhus

name:My Node Actionon:  -pull_requestjobs:my-action:runs-on:ubuntu-lateststeps:# Check out code using git      -uses:actions/checkout@v4# Install Node 20      -uses:actions/setup-node@v4with:node-version:20      -run:npm install @octokit/action# Node.js script can be anywhere. A good convention is to put local GitHub Actions# into the `.github/actions` folder      -run:node .github/actions/my-script.jsenv:GITHUB_TOKEN:${{ secrets.GITHUB_TOKEN }}

// .github/actions/my-script.jsimport{Octokit}from"@octokit/action";constoctokit=newOctokit();// `octokit` is now authenticated using GITHUB_TOKEN

Create an issue using REST API

import{Octokit}from"@octokit/action";constoctokit=newOctokit();const[owner,repo]=process.env.GITHUB_REPOSITORY.split("/");// See https://developer.github.com/v3/issues/#create-an-issueconst{ data}=awaitoctokit.request("POST /repos/{owner}/{repo}/issues",{  owner,  repo,title:"My test issue",});console.log("Issue created: %s",data.html_url);

Create an issue using GraphQL

import{Octokit}from"@octokit/action";constoctokit=newOctokit();consteventPayload=require(process.env.GITHUB_EVENT_PATH);constrepositoryId=eventPayload.repository.node_id;constresponse=awaitoctokit.graphql(`  mutation($repositoryId:ID!, $title:String!) {    createIssue(input:{repositoryId: $repositoryId, title: $title}) {      issue {        number      }    }  }  `,{    repositoryId,title:"My test issue",},);

Hooks, plugins, and more

TypeScript: Endpoint method parameters and responses

import{RestEndpointMethodTypes}from`@octokit/action`;typeChecksCreateParams=RestEndpointMethodTypes["checks"]["create"]["parameters"];typeChecksCreateResponse=RestEndpointMethodTypes["checks"]["create"]["response"];

Proxy Servers

How it works

License