Functions
	github_pages_prepare (repository)
	Prepare a local directory for working with GitHub pages. More...

	github_doc_commit (dir)
	Commit previously prepared documentation. More...

	github_releases_get_latest (repository)
	Returns the latest tagged version on the given repository. More...

	github_wiki_commit (dir)
	Commit previously prepared wiki directory. More...

	github_wiki_prepare (repository)
	Prepare a local directory for working with GitHub Wiki repo. More...

Detailed Description

Function Documentation

github_doc_commit ( dir )

Commit previously prepared documentation.

Parameters

dir	Temporary directory returned from previous invocation of `github_(pages\|wiki)_prepare()`.

github_pages_prepare ( repository )

Prepare a local directory for working with GitHub pages.

Parameters

repository GitHub repository; e.g. madworx/docshell.

Checks out the given repository's gh-pages branch in a temporary directory. Outputs the temporary directory on stdout.

github_releases_get_latest ( repository )

Returns the latest tagged version on the given repository.

Parameters

repository GitHub repository; e.g. madworx/docker-minix.

Environment variables: GH_TOKEN Only required if querying a private repository.

Please note: @n: There is a discrepancy between the GitHub "Releases API" vs. what's displayed on the GitHub web page. Releases displayed as "releases" on the GitHub web page is not necessarily "releases", but actually tags. Therefore, we instead look at the actual tags since this maps better to expected UX.

github_wiki_commit ( dir )

Commit previously prepared wiki directory.

Deprecated:: This function is deprecated. Use the generic github_doc_commit() function instead.

Parameters

dir	Temporary directory returned from previous call to `github_(pages\|wiki)_prepare()`.

github_wiki_prepare ( repository )

Prepare a local directory for working with GitHub Wiki repo.

Parameters

repository GitHub repository; e.g. madworx/docshell.

Outputs the temporary directory name you're supposed to put the Wiki files into to stdout.