Skip to main content

A Pulumi package for creating and managing github cloud resources.

Project description

Build Status

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/v5

.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: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:owner - (Optional) This is the target GitHub organization or individual user account to manage. For example, torvalds and github are valid owners. It is optional to provide this value and it can also be sourced from the GITHUB_OWNER environment variable. When not provided and a token is available, the individual user account owning the token will be used. When not provided and no token is available, the provider may not function correctly.
  • github:organization - (Deprecated) This behaves the same as owner, which should be used instead. This value can also be sourced from the GITHUB_ORGANIZATION environment variable.

Reference

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

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pulumi_github-5.27.0a1707890424.tar.gz (175.1 kB view details)

Uploaded Source

Built Distribution

pulumi_github-5.27.0a1707890424-py3-none-any.whl (329.5 kB view details)

Uploaded Python 3

File details

Details for the file pulumi_github-5.27.0a1707890424.tar.gz.

File metadata

File hashes

Hashes for pulumi_github-5.27.0a1707890424.tar.gz
Algorithm Hash digest
SHA256 19b8a6804100a6c84ae4ef20151cbbed79808ee2b12303506f022476a5298661
MD5 d6e124a882481414b14bf938df8b95d0
BLAKE2b-256 c2d70dd6e71defd8ee4559081319484d83f7b1e802636de8d3315e39957f078f

See more details on using hashes here.

File details

Details for the file pulumi_github-5.27.0a1707890424-py3-none-any.whl.

File metadata

File hashes

Hashes for pulumi_github-5.27.0a1707890424-py3-none-any.whl
Algorithm Hash digest
SHA256 575f6a3beb41c857062f8a25aea424cd9bebe82c8ee79d8b6cdc33573017e8ee
MD5 67e4949d93e337964514c46ee00b9287
BLAKE2b-256 79af7736a6367bce73a919ec9cc73458a13500ea3627ded19a2005c14cdc2389

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page