Skip to content

5 Senders

Anthony HAMON edited this page Dec 27, 2017 · 5 revisions

Senders are called when all operations are done on payload to render final result.

Stdout

Dump result to stdout

Name Value
CHYLE_SENDERS_STDOUT_FORMAT "json" : output payload as JSON , "template" : output payload using golang template syntax look at the help to get more informations
CHYLE_SENDERS_STDOUT_TEMPLATE Linked to "template" stdout format, it must be set to defined a template following golang template syntax, look at the help to get more informations

Github release api

It creates a new release in github with a template from datas you harvested, look at the documentation to have more details about what you can do.

Name Value
CHYLE_SENDERS_GITHUBRELEASE_CREDENTIALS_OAUTHTOKEN Github oauth token used to publish a release (mandatory)
CHYLE_SENDERS_GITHUBRELEASE_CREDENTIALS_OWNER Github owner (mandatory)
CHYLE_SENDERS_GITHUBRELEASE_RELEASE_DRAFT Create a draft (unpublished) release, default is false
CHYLE_SENDERS_GITHUBRELEASE_RELEASE_NAME Release title
CHYLE_SENDERS_GITHUBRELEASE_RELEASE_PRERELEASE Create a prerelease release, default is false
CHYLE_SENDERS_GITHUBRELEASE_RELEASE_TAGNAME Release tag to create, when you update a release it will be used to find out release tied to this tag (mandatory)
CHYLE_SENDERS_GITHUBRELEASE_RELEASE_TARGETCOMMITISH The commitish value that determines where the Git tag is created from
CHYLE_SENDERS_GITHUBRELEASE_RELEASE_TEMPLATE It uses golang template syntax to produce a changelog from your commits (mandatory), look at the help to get more informations
CHYLE_SENDERS_GITHUBRELEASE_RELEASE_UPDATE Set to true if you want to update an existing changelog, typical usage would be when you produce a release through GUI github release system
CHYLE_SENDERS_GITHUBRELEASE_REPOSITORY_NAME Github repository where we will publish the release (mandatory)

Custom api sender

Send release to a custom http endpoint through a POST request as a JSON payload.

Name Value
CHYLE_SENDERS_CUSTOMAPI_CREDENTIALS_TOKEN Access token given in request header "Authorization"
CHYLE_SENDERS_CUSTOMAPI_ENDPOINT_URL The URL endpoint where the POST request will be made
Clone this wiki locally