Skip to main content

A Pulumi package for creating and managing github cloud resources.

Project description

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

.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-6.0.0a1709100266.tar.gz (177.3 kB view details)

Uploaded Source

Built Distribution

pulumi_github-6.0.0a1709100266-py3-none-any.whl (332.6 kB view details)

Uploaded Python 3

File details

Details for the file pulumi_github-6.0.0a1709100266.tar.gz.

File metadata

File hashes

Hashes for pulumi_github-6.0.0a1709100266.tar.gz
Algorithm Hash digest
SHA256 442e649d1c49fc57165cbca663f4035c974ff286cda9c92d3b000a52b1953ff5
MD5 1f9034831d879d77291c72b7b0120451
BLAKE2b-256 7361a814a01f510b08c198d3d492d54a7e786a74124f6c60719e71a86e9b48cb

See more details on using hashes here.

File details

Details for the file pulumi_github-6.0.0a1709100266-py3-none-any.whl.

File metadata

File hashes

Hashes for pulumi_github-6.0.0a1709100266-py3-none-any.whl
Algorithm Hash digest
SHA256 cde962feda37b1fdf7407a0a00269f63d05a220e621af87eb15a1bb01a7f241d
MD5 345b9662c2ef2fc637e3b3f0334f470a
BLAKE2b-256 5085eab94cbf5c28b2376fec88f3e0607e20d956802f0c03c30a3bb2e8cd740d

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