@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

Pulumi GitHub Resource Provider

:warning: Pulumi is in private beta. This package may not work unless you are already participating. Please visit pulumi.com to register for access.

The GitHub provider for Pulumi lets you use Azure resources in your cloud programs.

This package is meant for use with the Pulumi CLI. Please visit docs.pulumi.com for installation instructions.