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.0a1705989202.tar.gz (174.2 kB view details)

Uploaded Source

Built Distribution

pulumi_github-5.27.0a1705989202-py3-none-any.whl (328.6 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for pulumi_github-5.27.0a1705989202.tar.gz
Algorithm Hash digest
SHA256 5114bb9a370d12dbbece2f16971fdfe7b51931a98e9d7f3fbfca852db22cab55
MD5 1dd16345d740eb50638463bfaceb3ba7
BLAKE2b-256 1f94fbd16b215a667464ecbf3d3d7f0e8e7c24b981e3c86731318ccdee260949

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pulumi_github-5.27.0a1705989202-py3-none-any.whl
Algorithm Hash digest
SHA256 a9afdf566b4e62e43a3e046a8c28e15525823a3fff7fefc818b61b3fb798f967
MD5 b2c2808ef7ef0aa4a2a4ef3459d1606c
BLAKE2b-256 a75df9adff4f7669ff7ccb724acef362103ea3ab45023c2c6be3f17e45498f92

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