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.26.0a1705643777.tar.gz (172.7 kB view details)

Uploaded Source

Built Distribution

pulumi_github-5.26.0a1705643777-py3-none-any.whl (326.9 kB view details)

Uploaded Python 3

File details

Details for the file pulumi_github-5.26.0a1705643777.tar.gz.

File metadata

File hashes

Hashes for pulumi_github-5.26.0a1705643777.tar.gz
Algorithm Hash digest
SHA256 d26d32813f57c1cd5af1070313ae89d40db755dd7968e11b532d284fed753826
MD5 b29f5efeb83402917029e29d70f735b7
BLAKE2b-256 0ca9fe3d9465f412aa67afb22e16657e1296975c83f1dc6a5a416c503bef91da

See more details on using hashes here.

File details

Details for the file pulumi_github-5.26.0a1705643777-py3-none-any.whl.

File metadata

File hashes

Hashes for pulumi_github-5.26.0a1705643777-py3-none-any.whl
Algorithm Hash digest
SHA256 1044cbccd65d2dfa156951365596a443f5e9edb18890f015a472c2de8e34a104
MD5 77f19fa3ac6a2e4bd19410f72f6482cc
BLAKE2b-256 7325c22be5611e0792972993bff76351413f9865ad9a010c11621116bf9b1770

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