@pulumi/github

What is @pulumi/github?

@pulumi/github is an npm package that allows you to manage GitHub resources using Pulumi, a modern infrastructure as code platform. With this package, you can automate the creation, configuration, and management of GitHub repositories, teams, issues, and more using Pulumi's programming model.

What are @pulumi/github's main functionalities?

Manage Repositories

This feature allows you to create and manage GitHub repositories. The code sample demonstrates how to create a new public repository named 'my-repo' with a description using Pulumi.

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

const repo = new github.Repository('my-repo', {
  name: 'my-repo',
  description: 'My awesome repository',
  private: false
});

exports.repoName = repo.name;

Manage Teams

This feature allows you to create and manage GitHub teams. The code sample demonstrates how to create a new team named 'my-team' with a description and closed privacy setting using Pulumi.

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

const team = new github.Team('my-team', {
  name: 'my-team',
  description: 'My awesome team',
  privacy: 'closed'
});

exports.teamName = team.name;

Manage Issues

This feature allows you to create and manage GitHub issues. The code sample demonstrates how to create a new issue in the 'my-repo' repository with a title, body, and assignee using Pulumi.

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

const issue = new github.Issue('my-issue', {
  repository: 'my-repo',
  title: 'Bug: Something is broken',
  body: 'Detailed description of the issue',
  assignees: ['username']
});

exports.issueTitle = issue.title;

Other packages similar to @pulumi/github

octokit

Octokit is the official GitHub SDK for JavaScript. It provides a comprehensive set of tools to interact with the GitHub API, allowing you to manage repositories, issues, pull requests, and more. Unlike @pulumi/github, which integrates with Pulumi for infrastructure as code, Octokit is a standalone library focused solely on GitHub API interactions.

node-github

Node-GitHub is a client library for the GitHub API written in JavaScript. It allows you to interact with various GitHub resources such as repositories, issues, and users. While it offers similar functionalities to @pulumi/github, it does not integrate with Pulumi and is used directly for API interactions.

gh

The 'gh' package is a command-line tool for GitHub. It allows you to perform various GitHub operations such as creating issues, managing pull requests, and more from the command line. Unlike @pulumi/github, which is used within a Pulumi program, 'gh' is used directly from the terminal.

README

GitHub provider

The GitHub resource provider for Pulumi lets you use GitHub resources in your infrastructure programs. To use this package, please install the Pulumi CLI first.

Installing

This package is available in many languages in the standard packaging formats.

Node.js (Java/TypeScript)

To use from JavaScript or TypeScript in Node.js, install using either npm:

$ npm install @pulumi/github

or yarn:

$ yarn add @pulumi/github

Python

To use from Python, install using pip:

$ pip install pulumi-github

Go

To use from Go, use go get to grab the latest version of the library

$ go get github.com/pulumi/pulumi-github/sdk/go/...

.NET

To use from .NET, install using dotnet add package:

$ dotnet add package Pulumi.Github

Configuration

The following configuration points are available:

• github:token - (Optional) This is the GitHub personal access token. It can also be sourced from the GITHUB_TOKEN environment variable. If anonymous is false, token is required.
• github:organization - (Optional) This is the target GitHub organization to manage. The account corresponding to the token will need "owner" privileges for this organization. It can also be sourced from the GITHUB_ORGANIZATION environment variable. If individual is set to false, organization is required.
• github:baseUrl - (Optional) This is the target GitHub base API endpoint. Providing a value is a requirement when working with GitHub Enterprise. It is optional to provide this value and it can also be sourced from the GITHUB_BASE_URL environment variable. The value must end with a slash, and generally includes the API version, for instance https://github.someorg.example/api/v3/.
• github:insecure - (Optional) Whether server should be accessed without verifying the TLS certificate. As the name suggests this is insecure and should not be used beyond experiments, accessing local (non-production) GHE instance etc. There is a number of ways to obtain trusted certificate for free, e.g. from Let's Encrypt. Such trusted certificate does not require this option to be enabled. Defaults to false.
• github:individual - (Optional) Run outside an organization. When individual is true, the provider will run outside the scope of an organization. Defaults to false.
• github:anonymous - (Optional) Authenticate without a token. When anonymous is true, the provider will not be able to access resources that require authentication. Setting to true will lead the GitHub provider to work in an anonymous mode with the corresponding API rate limits. Defaults to false.

Reference

For further information, please visit the GitHub provider docs or for detailed reference documentation, please visit the API docs.