Handles interacting with GitHub inside a Dangerfile. Provides a few functions which wrap
pr_json and also
through a few standard functions to simplify your code.
In Beta. Provides access to creating a GitHub Review instead of a typical GitHub comment.
To use you announce the start of your review, and the end via the
github.review.start github.review.fail(message) github.review.warn(message) github.review.message(message) github.review.markdown(message) github.review.submit
The title of the Pull Request.
The body text of the Pull Request.
The username of the author of the Pull Request.
The labels assigned to the Pull Request.
The branch to which the PR is going to be merged into.
The branch to which the PR is going to be merged from.
The base commit to which the PR is going to be merged as a parent.
The head commit to which the PR is requesting to be merged from.
The hash that represents the PR's JSON. For an example of what this looks like see the Danger Fixture'd one.
Provides access to the GitHub API client used inside Danger. Making it easy to use the GitHub API inside a Dangerfile.
The unified diff produced by Github for this PR see Unified diff
Returns a list of HTML anchors for a file, or files in the head repository. An example would be:
<a href='https://github.com/artsy/eigen/blob/561827e46167077b5e53515b4b7349b8ae04610b/file.txt'>file.txt</a>. It returns a string of multiple anchors if passed an array.
html_link (paths: String or Array
, full_path=true: Bool)String
Use to ignore inline messages which lay outside a diff's range, thereby not posting them in the main comment.
dismiss_out_of_range_messages (dismiss=true: Bool)