Cerberus

• Getting Started
• About
• Integration Guide
• Actions
  • find_tickets
  • find_commits
  • jira_comment
  • release_notes
• Example
• Run tests for this plugin
• Issues and Feedback
• Troubleshooting
• Using fastlane Plugins
• About fastlane

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

fastlane add_plugin cerberus

Cerberus is a fastlane plugin for extracting Jira issues from commit messages and sharing information on its respective Jenkins job and HockeyApp upload.

Using all of Cerberus' features, you can use your commit history -

 * HEAD -> Develop
 | \
 *   \
 | \ |
 | | * [CER-12] Address PR Feedback
 | | * [CER-12] Fix bug
 | | |
 | * | [CER-7] Add feature
 | / |

to generate release notes using data from Jira and your build -

### Changelog
- [CER-12] UI Bug
- [CER-7] Minor Feature

Built by [Jenkins](https://jenkins.url/build/451)

and comment on your Jira tickets with build and artefact information

Jenkins: [Build #451|https://jenkins.url/build/451]
HockeyApp: [Version 2.0-RC|https://hockey.url/app/d3adcaf3]

Please take a look at the project integration guide to get you started.

This action will extract tickets using a provided regular expression. The default format is as follows: ABC-123, one or more capital letters, followed by a dash, followed by one or more digits.

find_tickets(
 from: 'HEAD',
 to: '81fae0ffcc714fb56a1c186ae7c73c80442fff74',
 matching: '([A-Z]+-\d+)',
 excluding: 'TECH',
 pretty: '* (%h) %s'
)

Returns an Array of Strings. e.g ["CER-1", "CER-2"]

Extracts the commit messages from a set of commits using regex.

find_commits(
 from: 'HEAD',
 to: '81fae0ffcc714fb56a1c186ae7c73c80442fff74',
 matching: 'TECH',
 pretty: '%s'
)

Returns an Array of Strings. e.g ["[TECH] - Update SSL pinning"]

Adds a comment on the Jira isses with the CI build number and the link to the CI build it also adds a link to the HockeyApp build and its build number.

jira_comment(
 issues: ['CER-1', 'CER-2'],
 build_number: '1',
 build_url: 'https://www.jenkins.com/build/1',
 app_version: '1.0-QA',
 hockey_url: 'https://rink.hockeyapp.net/apps/32c5df727eac426',
 username: 'jenkins',
 password: 'XYZ123',
 host: 'https://jira.com',
 context_path: '',
 disable_ssl_verification: false
)

Adds a comment on all the issues provided which have an accociated Jira issue in the following format:

Jenkins: [Build ##{build_number}|#{build_url}]

HockeyApp: [Version #{app_version} (#{build_number})|#{hockey_url}]

Generates a changelog containing all the completed issues and any additional messages to be included as part of the changelog. It sets the FL_CHANGELOG shared value with the changelog.

release_notes(
 issues: ['CER-1', 'CER-2'],
 include_commits: ["[TECH] - Add SSL"],
 build_url: 'https://www.jenkins.com/build/1',
 username: 'jenkins',
 password: 'XYZ123',
 host: 'https://jira.com',
 context_path: '',
 disable_ssl_verification: false
)

Returns a String containing all the changes and additional messages in the following markdown format:

### Changelog

- [CER-1](URL): Issue summary
- TECH: Additional commit message

Built by [Jenkins](URL)

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.

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

rake

To automatically fix many of the styling issues, use

rubocop -a

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

If you have trouble using plugins, check out the Plugins Troubleshooting guide.

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

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