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.22.0a1697521527.tar.gz (185.0 kB view details)

Uploaded Source

Built Distribution

pulumi_github-5.22.0a1697521527-py3-none-any.whl (342.8 kB view details)

Uploaded Python 3

File details

Details for the file pulumi_github-5.22.0a1697521527.tar.gz.

File metadata

File hashes

Hashes for pulumi_github-5.22.0a1697521527.tar.gz
Algorithm Hash digest
SHA256 a4d71dcb5ef6e307e22b243a85858276e8d0f1f7555b14bf672ad846653dd9e4
MD5 2c9fa34f9c02c39d6311656cc21643a5
BLAKE2b-256 697864d52b0447d7be37046dd5e02db7d74cb17a6e2b7ef8faf6fca8e293d431

See more details on using hashes here.

File details

Details for the file pulumi_github-5.22.0a1697521527-py3-none-any.whl.

File metadata

File hashes

Hashes for pulumi_github-5.22.0a1697521527-py3-none-any.whl
Algorithm Hash digest
SHA256 7bf4e287d97886f1a0e58e47a147da65bbf3c4f6c007a553f4808b5a31694867
MD5 8e7f6b52602d620be086ca77980e42eb
BLAKE2b-256 c1c3e5868a24efe060351d870bf27eeedaf1b601273355f48a9109e4508e7f2f

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