This repository has been archived by the owner. It is now read-only.
Changelog generation based on merged pull requests & tags
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.
fastlane
lib/fastlane/plugin
spec
.gitignore
.rspec
.rubocop.yml
CHANGELOG.md
Gemfile
LICENSE
README.md
Rakefile
circle.yml
fastlane-plugin-changelog_generator.gemspec

README.md

changelog_generator plugin

fastlane Plugin Badge Twitter: @fsaragoca

CircleCI

Getting Started

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

fastlane add_plugin changelog_generator

About changelog_generator

changelog_generator
📖 Generate a changelog based on git tags & pull requests
✏️ Flexible configuration using a fully customisable template file
📃 Full access to pull request information directly from template

Example

This project automatically generates CHANGELOG.md when pushing changes to master, check out Fastfile and changelog_template.erb for project setup. Try it by cloning the repo, running fastlane install_plugins and bundle exec fastlane test.

Actions

📖 generate_changelog

changelog = generate_changelog(
  github_project: 'fsaragoca/fastlane-plugin-changelog_generator',
  github_api_token: 'GITHUB_API_TOKEN',
  base_branch: 'master',
  template_path: 'fastlane/changelog_template.erb',
  template: 'YOUR_ERB_TEMPLATE', # Must provide either template or template_path
  tags: ['v0.2.0', 'v0.1.0'], # Optional, defaults to all git tags
  max_number_of_tags: 10, # Optional, limits number of tags when using all git tags
  include_unreleased_section: true, # Optional, defaults to false
  output_path: 'CHANGELOG.md' # Optional
)

🚢 generate_release_changelog

v2_changelog = generate_release_changelog(
  github_project: 'fsaragoca/fastlane-plugin-changelog_generator',
  github_api_token: 'GITHUB_API_TOKEN',
  base_branch: 'master',
  template_path: 'fastlane/changelog_template.erb',
  template: 'YOUR_ERB_TEMPLATE', # Must provide either template or template_path
  tag_a: 'v0.2.0',
  tag_b: 'v0.1.0', # Optional, will be prompted if not provided
  skip_tag_b: true, # Optional, defaults to false
  output_path: 'RELEASE_0.2.0.md' # Optional
)

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.