| Name | pulumi-github JSON |
| Version |
5.0.0
JSON |
| download |
| home_page | https://pulumi.io |
| Summary | A Pulumi package for creating and managing github cloud resources. |
| upload_time | 2022-09-23 00:16:39 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | |
| license | Apache-2.0 |
| keywords |
pulumi
github
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://travis-ci.com/pulumi/pulumi-github)
# 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](https://pulumi.io/reference/cli/).
## 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](https://www.pulumi.com/docs/intro/cloud-providers/github)
or for detailed reference documentation, please visit [the API docs](https://www.pulumi.com/docs/reference/pkg/github).
Raw data
{
"_id": null,
"home_page": "https://pulumi.io",
"name": "pulumi-github",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "pulumi github",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/29/66/4591f2400a04f4ec938e6fa29477348577cdcd206fc4135430720bb8c08c/pulumi_github-5.0.0.tar.gz",
"platform": null,
"description": "[](https://travis-ci.com/pulumi/pulumi-github)\n\n# GitHub provider\n\nThe GitHub resource provider for Pulumi lets you use GitHub resources in your infrastructure programs. \nTo use this package, please [install the Pulumi CLI first](https://pulumi.io/reference/cli/).\n\n## Installing\n\nThis package is available in many languages in the standard packaging formats.\n\n### Node.js (Java/TypeScript)\n\nTo use from JavaScript or TypeScript in Node.js, install using either `npm`:\n\n $ npm install @pulumi/github\n\nor `yarn`:\n\n $ yarn add @pulumi/github\n\n### Python\n\nTo use from Python, install using `pip`:\n\n $ pip install pulumi-github\n\n### Go\n\nTo use from Go, use `go get` to grab the latest version of the library\n\n $ go get github.com/pulumi/pulumi-github/sdk/v5\n\n### .NET\n\nTo use from .NET, install using `dotnet add package`:\n\n $ dotnet add package Pulumi.Github\n\n## Configuration\n\nThe following configuration points are available:\n\n- `github:token` - (Optional) This is the GitHub personal access token. It can also be sourced from the `GITHUB_TOKEN`\n environment variable. If anonymous is false, token is required.\n- `github:baseUrl` - (Optional) This is the target GitHub base API endpoint. Providing a value is a requirement when\n working with GitHub Enterprise. It is optional to provide this value and it can also be sourced from the `GITHUB_BASE_URL`\n environment variable. The value must end with a slash, and generally includes the API version, for instance\n `https://github.someorg.example/api/v3/`.\n- `github:owner` - (Optional) This is the target GitHub organization or individual user account to manage. For example, \n `torvalds` and `github` are valid owners. It is optional to provide this value and it can also be sourced from the \n `GITHUB_OWNER` environment variable. When not provided and a token is available, the individual user account owning \n the token will be used. When not provided and no token is available, the provider may not function correctly.\n- `github:organization` - (Deprecated) This behaves the same as owner, which should be used instead. This value can also \n be sourced from the `GITHUB_ORGANIZATION` environment variable.\n\n## Reference\n\nFor further information, please visit [the GitHub provider docs](https://www.pulumi.com/docs/intro/cloud-providers/github)\nor for detailed reference documentation, please visit [the API docs](https://www.pulumi.com/docs/reference/pkg/github).\n\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A Pulumi package for creating and managing github cloud resources.",
"version": "5.0.0",
"split_keywords": [
"pulumi",
"github"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "ef0bcd87d684cc24e64261c64a45c1aa",
"sha256": "2aa12442c713ee5339280af0ece00b928f6923bf3c19c0a5961252791585be75"
},
"downloads": -1,
"filename": "pulumi_github-5.0.0.tar.gz",
"has_sig": false,
"md5_digest": "ef0bcd87d684cc24e64261c64a45c1aa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 63502,
"upload_time": "2022-09-23T00:16:39",
"upload_time_iso_8601": "2022-09-23T00:16:39.735693Z",
"url": "https://files.pythonhosted.org/packages/29/66/4591f2400a04f4ec938e6fa29477348577cdcd206fc4135430720bb8c08c/pulumi_github-5.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-09-23 00:16:39",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "pulumi-github"
}
