make_changelog_from_jenkins
Generate a changelog using the Changes section from the current Jenkins build
This is useful when deploying automated builds. The changelog from Jenkins lists all the commit messages since the last build.
| make_changelog_from_jenkins | |
|---|---|
| Supported platforms | ios, android, mac |
| Author | @mandrizzle |
1 Example
make_changelog_from_jenkins(
# Optional, lets you set a changelog in the case is not generated on Jenkins or if ran outside of Jenkins
fallback_changelog: "Bug fixes and performance enhancements"
)
Parameters
| Key | Description | Default |
|---|---|---|
fallback_changelog |
Fallback changelog if there is not one on Jenkins, or it couldn't be read | '' |
include_commit_body |
Include the commit body along with the summary | true |
* = default value is dependent on the user's system
Lane Variables
Actions can communicate with each other using a shared hash lane_context, that can be accessed in other actions, plugins or your lanes: lane_context[SharedValues:XYZ]. The make_changelog_from_jenkins action generates the following Lane Variables:
| SharedValue | Description |
|---|---|
SharedValues::FL_CHANGELOG |
The changelog generated by Jenkins |
To get more information check the Lanes documentation.
Documentation
To show the documentation in your terminal, run
fastlane action make_changelog_from_jenkins
CLI
It is recommended to add the above action into your Fastfile, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
fastlane run make_changelog_from_jenkins
To pass parameters, make use of the : symbol, for example
fastlane run make_changelog_from_jenkins parameter1:"value1" parameter2:"value2"
It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g. param:"1,2,3"). Hashes are not currently supported.
It is recommended to add all fastlane actions you use to your Fastfile.
Source code
This action, just like the rest of fastlane, is fully open source, view the source code on GitHub