Pre-release
This release is a pre-release and may not be stable for production use.
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/go/...
Configuration
The following configuration points are available:
github:token- (Optional) This is the GitHub personal access token. It can also be sourced from theGITHUB_TOKENenvironment variable. If anonymous is false, token is required.github:organization- (Optional) This is the target GitHub organization to manage. The account corresponding to the token will need "owner" privileges for this organization. It can also be sourced from theGITHUB_ORGANIZATIONenvironment variable. If individual is set to false, organization 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 theGITHUB_BASE_URLenvironment variable. The value must end with a slash, and generally includes the API version, for instancehttps://github.someorg.example/api/v3/.github:insecure- (Optional) Whether server should be accessed without verifying the TLS certificate. As the name suggests this is insecure and should not be used beyond experiments, accessing local (non-production) GHE instance etc. There is a number of ways to obtain trusted certificate for free, e.g. from Let's Encrypt. Such trusted certificate does not require this option to be enabled. Defaults tofalse.github:individual- (Optional) Run outside an organization. When individual is true, the provider will run outside the scope of an organization. Defaults tofalse.github:anonymous- (Optional) Authenticate without a token. When anonymous is true, the provider will not be able to access resources that require authentication. Setting to true will lead the GitHub provider to work in an anonymous mode with the corresponding API rate limits. Defaults tofalse.
Reference
1 maintainer
Release files for pulumi-github 1.4.0a1589931132
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pulumi_github-1.4.0a1589931132.tar.gz | 28.4 kB | Details |
Release files / pulumi_github-1.4.0a1589931132.tar.gz
| Download URL | pulumi_github-1.4.0a1589931132.tar.gz |
|---|---|
| Size | 28.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
360be32c330a40de9f5873882d47dd5bded543f3c22f336f9d55fe82e0cf4b59
|
|
BLAKE2b-256 checksum How to use checksums |
5e4ba51d342343b30422ecd25137008ae4c6ca6b33f7ed7e3478a866acb0e14f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/39.0.1 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.7
|
