Improve traceability in your build chain using fastlane 🚀
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
blog
fastlane
lib/fastlane/plugin
spec
.gitignore
.rspec
.rubocop.yml
.travis.yml
Gemfile
INTEGRATION.md
LICENSE
README.md
Rakefile
fastlane-plugin-cerberus.gemspec

README.md

Cerberus

fastlane Plugin Badge CircleCI

Getting Started

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

fastlane add_plugin cerberus

About

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]

Integration Guide

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

Actions

find_tickets

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.

Parameters

Parameter Environment Name Default Value Description
from FL_FIND_TICKETS_FROM 'HEAD' The commit SHA of the first commit to parse for ticket information.
to FL_FIND_TICKETS_TO ENV[GIT_PREVIOUS_SUCCESSFUL_COMMIT] or 'HEAD' The commit SHA of the last commit to parse for ticket information.
matching FL_FIND_TICKETS_MATCHING '([A-Z]+-\d+)' Regex which will be used to extract the tickets from the commit messages.
excluding FL_FIND_TICKETS_EXCLUDING Additional regex to ignore specific commits or keywords.
pretty FL_FIND_TICKETS_PRETTY_FORMAT '* (%h) %s' A git log pretty format.

Usage

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

Result

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


find_commits

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

Parameters

Parameter Environment Name Default Value Description
from FL_FIND_COMMITS_FROM ENV['FL_FIND_TICKETS_FROM'] The commit SHA of the first commit to parse for ticket information.
to FL_FIND_COMMITS_TO ENV['FL_FIND_TICKETS_TO'] The commit SHA of the last commit to parse for ticket information.
matching FL_FIND_COMMITS_MATCHING ENV['FL_FIND_TICKETS_MATCHING'] Regex which will be used to extract the tickets from the commit messages.
pretty FL_FIND_COMMITS_PRETTY_FORMAT ENV['FL_FIND_TICKETS_PRETTY_FORMAT'] A git log pretty format.

Usage

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

Result

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


jira_comment

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.

Parameters

Parameter Environment Name Default Value Description
issues FL_JIRA_COMMENT_ISSUES [] The Jira issues to comment on. An Array of Strings.
build_number FL_JIRA_COMMENT_BUILD_NUMBER ENV['BUILD_NUMBER'] The CI build number that built the current changes.
build_url FL_JIRA_COMMENT_BUILD_URL ENV['BUILD_URL'] URL to the CI build.
app_version FL_JIRA_COMMENT_APP_VERSION The current app version.
hockey_url FL_JIRA_COMMENT_HOCKEY_URL Actions.lane_context[SharedValues::HOCKEY_DOWNLOAD_LINK] URL to the HockeyApp build.
username FL_JIRA_USERNAME Jira username.
password FL_JIRA_PASSWORD Jira password.
host FL_JIRA_HOST Jira host location.
context_path FL_JIRA_CONTEXT_PATH '' Jira context path.
disable_ssl_verification FL_JIRA_DISABLE_SSL_VERIFICATION false Disable Jira SSL verification.

Usage

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
)

Result

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}]

release_notes

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.

Parameters

Parameter Environment Name Default Value Description
issues FL_RELEASE_NOTES_ISSUES [] The Jira issues completed as part of this build. An Array of Strings.
include_commits FL_HOCKEY_COMMENT_INCLUDE_COMMITS [] Additional commit messages to be included as part of the release notes.
build_url FL_RELEASE_NOTES_BUILD_URL ENV['BUILD_URL'] URL to the CI build.
username FL_JIRA_USERNAME Jira username.
password FL_JIRA_PASSWORD Jira password.
host FL_JIRA_HOST Jira host location.
context_path FL_JIRA_CONTEXT_PATH '' Jira context path.
disable_ssl_verification FL_JIRA_DISABLE_SSL_VERIFICATION false Disable Jira SSL verification.

Usage

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
)

Result

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)

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 guide.

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.