monkey.ci.plugin.github

Liking cljdoc? Tell your friends :D

Clojure only.

create-release!
format-tag
make-client
parse-url
release-job
token-param

Provides functions for interacting with the Github API from a MonkeyCI build

Provides functions for interacting with the Github API from a MonkeyCI build

raw docstring

create-release!^clj

(create-release! c {:keys [org repo tag name desc target]})

Creates a new release for the repository identified by org and repo. The tag specifies the tag to use for the release, or, if it does not exist, to create. In the latter case, a target commitish should be given on which to create the tag. If not given, the default branch is used. An additional name and desc are used for extra information. Returns the http result, should be status 201 if successful.

Creates a new release for the repository identified by `org` and `repo`.
The `tag` specifies the tag to use for the release, or, if it does not
exist, to create.  In the latter case, a `target` commitish should be
given on which to create the tag.  If not given, the default branch is 
used.  An additional `name` and `desc` are used for extra information.
Returns the http result, should be status 201 if successful.

source raw docstring

format-tag^clj

(format-tag tag {:keys [name-format] :or {name-format "v%s"}})

source

make-client^clj

Creates a new Github api client. You can pass in a token, or api key with secret.

Creates a new Github api client.  You can pass in a token, or api key with secret.

source raw docstring

parse-url^clj

(parse-url git-url)

Parses git url to extract org and repo

Parses git url to extract org and repo

source raw docstring

release-job^clj

(release-job & [{:keys [token] :as config}])

Returns a fn that will in turn create a release job, if the conditions are met. By default a release will be created if the build is triggered from a tag, and the tag name is used to format the release name. Note that either a :token must be specified, or a github-token build param must be provided.

Returns a fn that will in turn create a release job, if the conditions are met.
By default a release will be created if the build is triggered from a tag, and
the tag name is used to format the release name.  Note that either a `:token`
must be specified, or a `github-token` build param must be provided.

source raw docstring