GitHub

The github module provides several helper functions to query GitHub, along with the connection information for more advanced usage.

Configuration

The github configuration is automatically detected from the environment and git.

• The GitHub token is read from the GITHUB_TOKEN environment variable. Some queries might work without authentication for public repositories.

GitHub CodeSpaces

In a GitHub CodeSpace, the GITHUB_TOKEN is automatically provisioned.

GitHub Actions

In GitHub Actions, you might need to add permissions to the workspace to access workflow logs, pull requests and or Marketplace Models. Additionally, you need to pass the secret.GITHUB_TOKEN to the GenAIScript script run.

genai.yml

permissions:
    contents: read
    actions: read
    pull-requests: read # or write if you plan to create comments
    models: read # access to GitHub Marketplace Models
...
    - run: npx --yes genaiscript ...
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        ...

Functions

Issues

You can query issues and issue comments using listIssues and listIssueComments.

const issues = await github.listIssues({ per_page: 5 })
console.log(issues.map((i) => i.title))

// Use issue number!
const issueComments = await github.listIssueComments(issues[0].number)
console.log(issueComments)

You can also create issue comments:

// Use issue number!
await github.createIssueComment(issues[0].number, "Hello, world!")

Pull Requests

Query pull requests and pull request review comments using listPullRequests and listPullRequestReviewComments.

const prs = await github.listPullRequests({ per_page: 5 })
console.log(prs.map((i) => i.title))

// Use pull request number!
const prcs = await github.listPullRequestReviewComments(prs[0].number)
console.log(prcs.map((i) => i.body))

In GitHub Actions, ensure the pull-request: read permission is granted.

Workflow Runs

Access the log of workflow runs to analyze failures with listWorkflowRuns.

// List runs
const runs = await github.listWorkflowRuns("build.yml", { per_page: 5 })
console.log(runs.map((i) => i.status))

const jobs = await github.listWorkflowJobs(runs[0].id)
// Redacted job log
console.log(jobs[0].content)

In GitHub Actions, grant the actions: read permission.

Search Code

Use searchCode for a code search on the default branch in the same repository.

const res = await github.searchCode("HTMLToText")
console.log(res)

Get File Content

Retrieve file content for a given ref, tag, or commit SHA using getFile.

const pkg = await github.getFile("package.json", "main")
console.log(pkg.content.slice(0, 50) + "...")

Get Repository Content

List files or directories at a path in a remote repository. By default, file contents from a directory are not loaded. Use downloadContent: true.

// Get top-level markdown files
const files = await github.getRepositoryContent("", {
    type: "file",
    glob: "*.md",
    downloadContent: true,
    maxDownloadSize: 2_000,
})

Upload asset

This API requires contents: write permission in GitHub Actions. It uploads data into an orphaned branch in the Repository and returns the URL to the uploaded asset.

const url = await github.uploadAsset(file)
console.log(url)

The URL can be used in markdown in comments or issues.

Note

It takes a few minutes for the asset to be available at this URL.

Languages

Query the list of programming languages that GitHub computed for the repository using listRepositoryLanguages.

const languages = await github.listRepositoryLanguages()

Branches

List the branches on the repository using listBranches.

const branches = await github.listBranches()
console.log(branches)

Releases

List the releases on the repository using listReleases.

const releases = await github.listReleases()
console.log(releases)

Octokit access

Utilize octokit to access the full GitHub APIs.

import { Octokit } from "@octokit/core"

const { client }: { client: Octokit } = await github.api()
...

Install octokit in your list of packages:

npm

npm i -D octokit

pnpm

pnpm add -D octokit

yarn

yarn add -D octokit

Working on a different repository

Use client to open a github client on a different repository using the same secrets.

const client = github.client("owner", "repo")