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.2a1775837588.tar.gz (256.6 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.2a1775837588-py3-none-any.whl (457.9 kB view details)

Uploaded Python 3

File details

Details for the file pulumi_github-6.12.2a1775837588.tar.gz.

File metadata

File hashes

Hashes for pulumi_github-6.12.2a1775837588.tar.gz
Algorithm Hash digest
SHA256 b5aa4add22c1e76902fdabd010d4c00f45503b953f31425432f19c4743decbb6
MD5 7bd7f0fff6bd53328da807ab72583522
BLAKE2b-256 b9e49cc677ae853c39d211916f392df604b3075b9a757dacc634d2630afa8dd5

See more details on using hashes here.

File details

Details for the file pulumi_github-6.12.2a1775837588-py3-none-any.whl.

File metadata

File hashes

Hashes for pulumi_github-6.12.2a1775837588-py3-none-any.whl
Algorithm Hash digest
SHA256 ed18c834e954962839459448267019726285017beae26e3f839be4183e897636
MD5 b348e4a50710621a63fdf664bb383745
BLAKE2b-256 b3a1cf848900be485013458a531b8f5d8f7f5ec938cbe25e658cf61327eff52b

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