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.12.0a1770098315.tar.gz (236.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pulumi_github-6.12.0a1770098315-py3-none-any.whl (430.6 kB view details)

Uploaded Python 3

File details

Details for the file pulumi_github-6.12.0a1770098315.tar.gz.

File metadata

File hashes

Hashes for pulumi_github-6.12.0a1770098315.tar.gz
Algorithm Hash digest
SHA256 ebc7e8219e867ee001e5850e197a8fdf1bee1f83d189a1ea00e3627015e4a3ac
MD5 d78e20ef504cdb405b6e80163b1835c6
BLAKE2b-256 a8ecd9355b6e3b4555b6d0875f68ee001873e34176c11d440d697ca9a3857f82

See more details on using hashes here.

File details

Details for the file pulumi_github-6.12.0a1770098315-py3-none-any.whl.

File metadata

File hashes

Hashes for pulumi_github-6.12.0a1770098315-py3-none-any.whl
Algorithm Hash digest
SHA256 6b8f3e069932d8d2d004153a945c865851fab792c19c2c3f5e3948a52e13d790
MD5 f5e241ecd06a4258e6fcfc43948a0774
BLAKE2b-256 8d3e57fa976446d33eede3cbb7b32ca0e083ce748857253d635d1085d12b20ac

See more details on using hashes here.

Supported by

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