Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maximilien/kn-source-github
Kn plugin for GitHub event source
https://github.com/maximilien/kn-source-github
cli kn kn-plugin knative
Last synced: 5 days ago
JSON representation
Kn plugin for GitHub event source
- Host: GitHub
- URL: https://github.com/maximilien/kn-source-github
- Owner: maximilien
- License: apache-2.0
- Created: 2020-03-13T21:56:18.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-08-28T21:33:29.000Z (about 4 years ago)
- Last Synced: 2024-06-20T10:04:12.129Z (5 months ago)
- Topics: cli, kn, kn-plugin, knative
- Language: Go
- Size: 6.89 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# github
Knative Client plugin `github`
## Usage
### github
Knative eventing GitHub source plugin
#### Synopsis
Manage your Knative GitHub eventing sources
#### Options
```
-h, --help help for github
```
#### SEE ALSO
* [github create](#github-create) - create NAME
* [github delete](#github-delete) - delete NAME
* [github describe](#github-describe) - describe NAME
* [github update](#github-update) - update NAME
### github create
create NAME
#### Synopsis
create a GitHub source
```
github create NAME [flags]
```
#### Examples
```
# Creates a new GitHub source with NAME using credentials
kn source github create NAME --access-token $MY_ACCESS_TOKEN --secret-token $MY_SECRET_TOKEN
# Creates a new GitHub source with NAME with specified organization and repository using credentials
kn source github create NAME --org knative --repo client-contrib --access-token $MY_ACCESS_TOKEN --secret-token $MY_SECRET_TOKEN
```
#### Options
```
--access-token string The GitHub access-token to use
-A, --all-namespaces If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace.
--api-url string The GitHub API URL to use (default "https://api.github.com")
-h, --help help for create
-n, --namespace string Specify the namespace to operate in.
--org string The GitHub organization or username
--repo string Repository name to consume messages from
--secret-token string The GitHub secret-token to use
-s, --sink string Addressable sink for events. You can specify a broker, Knative service or URI. Examples: '--sink broker:nest' for a broker 'nest', '--sink https://event.receiver.uri' for an URI with an 'http://' or 'https://' schema, '--sink 'ksvc:receiver' or simply '--sink receiver' for a Knative service 'receiver'. If prefix is not provided, it is considered as a Knative service.
```
#### SEE ALSO
* [github](#github) - Knative eventing GitHub source plugin
### github delete
delete NAME
#### Synopsis
delete a GitHub source
```
github delete NAME [flags]
```
#### Examples
```
# Deletes a GitHub source with NAME
kn source github delete NAME
```
#### Options
```
-A, --all-namespaces If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace.
-h, --help help for delete
-n, --namespace string Specify the namespace to operate in.
```
#### SEE ALSO
* [github](#github) - Knative eventing GitHub source plugin
### github describe
describe NAME
#### Synopsis
update a GitHub source
```
github describe NAME [flags]
```
#### Examples
```
# Describes a GitHub source with NAME
kn source github describe NAME
```
#### Options
```
-A, --all-namespaces If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace.
-h, --help help for describe
-n, --namespace string Specify the namespace to operate in.
```
#### SEE ALSO
* [github](#github) - Knative eventing GitHub source plugin
### github update
update NAME
#### Synopsis
update a GitHub source
```
github update NAME [flags]
```
#### Examples
```
# Updates a GitHub source with NAME
kn source github update NAME
```
#### Options
```
--access-token string The GitHub access-token to use
-A, --all-namespaces If present, list the requested object(s) across all namespaces. Namespace in current context is ignored even if specified with --namespace.
--api-url string The GitHub API URL to use (default "https://api.github.com")
-h, --help help for update
-n, --namespace string Specify the namespace to operate in.
--org string The GitHub organization or username
--repo string Repository name to consume messages from
--secret-token string The GitHub secret-token to use
-s, --sink string Addressable sink for events. You can specify a broker, Knative service or URI. Examples: '--sink broker:nest' for a broker 'nest', '--sink https://event.receiver.uri' for an URI with an 'http://' or 'https://' schema, '--sink 'ksvc:receiver' or simply '--sink receiver' for a Knative service 'receiver'. If prefix is not provided, it is considered as a Knative service.
```
#### SEE ALSO
* [github](#github) - Knative eventing GitHub source plugin
## More information
* [Knative Client](https://github.com/knative/client)
* [How to contribute a plugin](https://github.com/knative/client-contrib#how-to-contribute-a-plugin)