github_job_status plugin

fastlane Plugin Badge

Getting Started

This project is a fastlane plugin. To get started with fastlane-plugin-github_job_status, add it to your project by running:

fastlane add_plugin github_job_status

About github_job_status

Post the status of your test jobs to your pull requests. This uses GihHub's status API. Statuses posted to pull requests look this: screen shot 2016-12-16 at 2 25 20 pm

This plugin can be used in the following way:

github_job_status(
  token: 'github_OAuth_token',
  owner: 'justinsinger',
  repo: 'fastlane_plugins',
  sha: 'commit_sha',
  job_name: 'good_job',
  description: 'A short description',
  build_url: 'skullcrushers.gov',
  state: 'pending'
)
  • token can be obtained in GitHub for an owner (To do this, go to settings/Personal access tokens. Generate a new token and be sure to enable repo:status.)
    • state must be pending, success, error, or failure
    • sha is optional, and the default value is the last commit hash (thanks to last_git_commit)
    • job_name, description and build_url are optional

Example

Check out the example Fastfile to see how to use this plugin. Try it by cloning the repo, running fastlane install_plugins and bundle exec fastlane test.

Run tests for this plugin

To run both the tests, and code style validation, run

rake

To automatically fix many of the styling issues, use

rubocop -a

Issues and Feedback

For any other issues and feedback about this plugin, please submit it to this repository.

Troubleshooting

If you have trouble using plugins, check out the Plugins Troubleshooting doc in the main fastlane repo.

Using fastlane Plugins

For more information about how the fastlane plugin system works, check out the Plugins documentation.

About fastlane

fastlane is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out fastlane.tools.