6.0.0 • Published 6 months ago

@actions/github v6.0.0

Weekly downloads
349,118
License
MIT
Repository
github
Last release
6 months ago

@actions/github

A hydrated Octokit client.

Usage

Returns an authenticated Octokit client that follows the machine proxy settings and correctly sets GHES base urls. See https://octokit.github.io/rest.js for the API.

const github = require('@actions/github');
const core = require('@actions/core');

async function run() {
    // This should be a token with access to your repository scoped in as a secret.
    // The YML workflow will need to set myToken with the GitHub Secret Token
    // myToken: ${{ secrets.GITHUB_TOKEN }}
    // https://help.github.com/en/actions/automating-your-workflow-with-github-actions/authenticating-with-the-github_token#about-the-github_token-secret
    const myToken = core.getInput('myToken');

    const octokit = github.getOctokit(myToken)

    // You can also pass in additional options as a second parameter to getOctokit
    // const octokit = github.getOctokit(myToken, {userAgent: "MyActionVersion1"});

    const { data: pullRequest } = await octokit.rest.pulls.get({
        owner: 'octokit',
        repo: 'rest.js',
        pull_number: 123,
        mediaType: {
          format: 'diff'
        }
    });

    console.log(pullRequest);
}

run();

You can also make GraphQL requests. See https://github.com/octokit/graphql.js for the API.

const result = await octokit.graphql(query, variables);

Finally, you can get the context of the current action:

const github = require('@actions/github');

const context = github.context;

const newIssue = await octokit.rest.issues.create({
  ...context.repo,
  title: 'New issue!',
  body: 'Hello Universe!'
});

Webhook payload typescript definitions

The npm module @octokit/webhooks-definitions provides type definitions for the response payloads. You can cast the payload to these types for better type information.

First, install the npm module npm install @octokit/webhooks-definitions

Then, assert the type based on the eventName

import * as core from '@actions/core'
import * as github from '@actions/github'
import {PushEvent} from '@octokit/webhooks-definitions/schema'

if (github.context.eventName === 'push') {
  const pushPayload = github.context.payload as PushEvent
  core.info(`The head commit is: ${pushPayload.head_commit}`)
}

Extending the Octokit instance

@octokit/core now supports the plugin architecture. You can extend the GitHub instance using plugins.

For example, using the @octokit/plugin-enterprise-server you can now access enterprise admin apis on GHES instances.

import { GitHub, getOctokitOptions } from '@actions/github/lib/utils'
import { enterpriseServer220Admin } from '@octokit/plugin-enterprise-server'

const octokit = GitHub.plugin(enterpriseServer220Admin)
// or override some of the default values as well 
// const octokit = GitHub.plugin(enterpriseServer220Admin).defaults({userAgent: "MyNewUserAgent"})

const myToken = core.getInput('myToken');
const myOctokit = new octokit(getOctokitOptions(token))
// Create a new user
myOctokit.rest.enterpriseAdmin.createUser({
  login: "testuser",
  email: "testuser@test.com",
});
@francoadn/ta-core-libgithub-actions-kitissue_triage_actionsync-jira-subtask-to-gh-issues-actionaction-verify-pr-labelstravpro-actionsdavidgortegacmltest@onezerocompany/versioning@hediet/npm-template@sdlc.vitechteam/pipe-helper@sdlc.vitechteam/sdlc-pipelines-helper@sdlc.vitechteam/sdlcpipemti-testanyone-validate-fs@cutting/wait-for-vercel-preview-url@fundamend/action-github-tag@crazymax/actions-toolkit@liudonghua123/tauri-actiontokenlinkgithub-pr-collectorsfdx-hardis@everything-registry/sub-chunk-26jsgithubactionemulatorlinettalabel-approved-actionheroplan_data_validatorheroku-review-apphuggingface-synckapix-github-cilastfm-readmeifttt-actionis-baguette-title-semanticissues-generationjamesons-actions-toolkitjest-coverage-comment-actionlocal-actionmonorepo-container-builder-actionnode-package-release-actionmarkdown-autodocsmr-tools-libmove-stale-issueshello-world-js-actionhello-world-js-action-testjs-eval-action-expression-contextinterpret-integration-test-resultsncm-climanage-collaborators-actionmanage-users-actionnotion-jamnotion-bloggernotion-github-actionnpm-demo-shinnpm-package-deployerjest-github-actionexample-gh-functionseslint-suggestion-actiongoogle-calendar-importgha-test-repogh-repo.actiongcs-cache-actiongithub-read-time-badgegithub-fetch-workflow-artifactgithub-pages-deploy-actionheader-commentsfirebase-rules-bundlerfirestore-document-type-partternsfirestore-document-type-patternsfediverse-actionfoundry-toolchaingeneral-autotagget-github-releaseget-pr-labels-on-push-actiongh-pkg-examplegh-release-changelog@deuscx/issue-blog-actiongh-action-auto-releasegh-helpersgithub-actions-releasergithub-actions-startergithub-action-heroku-review-appgithub-action-readme-generatorgithub-action-ts-run-apigithub-cooldown-actiongithub-comment-floodgategithub-checkoutgithub-events-email-templategitwzga-sync-issues-to-jiragas-appoctoflarenx-githubquick-security-headers-checkpull-request-statspull-request-virpullup-sandboxpr-heroku-review-apppr-label-actionprcolinterpr-collectorproductboard-gh-action
6.0.0

6 months ago

5.1.1

1 year ago

5.1.0

2 years ago

5.0.3

2 years ago

5.0.2

2 years ago

5.0.1

2 years ago

5.0.0

3 years ago

4.0.0

4 years ago

3.0.0

4 years ago

2.2.0

4 years ago

2.1.1

4 years ago

2.1.0

4 years ago

2.0.1

4 years ago

2.0.0

4 years ago

1.1.0

5 years ago

1.0.1

5 years ago

1.0.0

5 years ago