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

Uploaded Source

Built Distribution

pulumi_github-5.22.0a1698476545-py3-none-any.whl (320.7 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for pulumi_github-5.22.0a1698476545.tar.gz
Algorithm Hash digest
SHA256 4330a6b96c5fed4dfa60fdb590f7a7b92071ca31f1db03d74b7514535fea514b
MD5 17e6ae4f1de389b6648438357f05fc78
BLAKE2b-256 c41d161c2e83be02c7b6566dca714a93cb021bf112005e5ecd109afde1755852

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pulumi_github-5.22.0a1698476545-py3-none-any.whl
Algorithm Hash digest
SHA256 f7bdd2d0e52ecde4b91d1309bc2ae9000752bd8170e941e501e9dc02548f0412
MD5 e9ba3a678eb058ee13caab394171d9ad
BLAKE2b-256 74b5521bcf7829ed1c718e836ebe9963859e1fd2f8f5d0bb7558828b2d4025b2

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