fastlane-plugin-changelog_generator 0.2.0 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 185b3f9fdfd4c3246c1b02a772ed9cd69958276f
|
|
4
|
+
data.tar.gz: 399ccec181e5093a709809b9dce5faa0b45bf93d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 882ad3fc54210997d8f0764113411b4d8e49db6e10a08f13f090ef69c2dd9e4e6355d8c41a838af376dba1bb25a71b5739f701c87a387518f56bea57f14b0407
|
|
7
|
+
data.tar.gz: 359ac64fed52cf5fa7edea756ab1ed438f3ae9a08a931d952768a65d1a9da9c28299b95413b4d32ed0020a52e5d607ab0da4e033a50857589178742aef262dfd
|
data/README.md
CHANGED
|
@@ -1,6 +1,9 @@
|
|
|
1
1
|
# changelog_generator plugin
|
|
2
2
|
|
|
3
3
|
[](https://rubygems.org/gems/fastlane-plugin-changelog_generator)
|
|
4
|
+
[](https://twitter.com/fsaragoca)
|
|
5
|
+
|
|
6
|
+
[](https://circleci.com/gh/fsaragoca/fastlane-plugin-changelog_generator)
|
|
4
7
|
|
|
5
8
|
## Getting Started
|
|
6
9
|
|
|
@@ -12,11 +15,49 @@ fastlane add_plugin changelog_generator
|
|
|
12
15
|
|
|
13
16
|
## About changelog_generator
|
|
14
17
|
|
|
15
|
-
|
|
18
|
+
| | changelog_generator |
|
|
19
|
+
|-------------------|-----------------------|
|
|
20
|
+
| :book: | Generate a [changelog](https://github.com/fsaragoca/fastlane-plugin-changelog_generator/blob/master/CHANGELOG.md) based on git tags & pull requests
|
|
21
|
+
| :pencil2: | Flexible configuration using a fully customisable [template file](https://github.com/fsaragoca/fastlane-plugin-changelog_generator/blob/master/fastlane/changelog_template.erb)
|
|
22
|
+
| :page_with_curl: | Full access to [pull request information](https://developer.github.com/v3/pulls/#get-a-single-pull-request) directly from template
|
|
16
23
|
|
|
17
24
|
## Example
|
|
18
25
|
|
|
19
|
-
|
|
26
|
+
This project automatically generates [`CHANGELOG.md`](CHANGELOG.md) when pushing changes to `master`, check out [`Fastfile`](fastlane/Fastfile) and [`changelog_template.erb`](fastlane/changelog_template.erb) for project setup. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
|
|
27
|
+
|
|
28
|
+
## Actions
|
|
29
|
+
|
|
30
|
+
### :book: generate_changelog
|
|
31
|
+
|
|
32
|
+
```
|
|
33
|
+
changelog = generate_changelog(
|
|
34
|
+
github_project: 'fsaragoca/fastlane-plugin-changelog_generator',
|
|
35
|
+
github_api_token: 'GITHUB_API_TOKEN',
|
|
36
|
+
base_branch: 'master',
|
|
37
|
+
template_path: 'fastlane/changelog_template.erb',
|
|
38
|
+
template: 'YOUR_ERB_TEMPLATE', # Must provide either template or template_path
|
|
39
|
+
tags: ['v0.2.0', 'v0.1.0'], # Optional, defaults to all git tags
|
|
40
|
+
max_number_of_tags: 10, # Optional, limits number of tags when using all git tags
|
|
41
|
+
include_unreleased_section: true, # Optional, defaults to false
|
|
42
|
+
output_path: 'CHANGELOG.md' # Optional
|
|
43
|
+
)
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### :ship: generate_release_changelog
|
|
47
|
+
|
|
48
|
+
```
|
|
49
|
+
v2_changelog = generate_release_changelog(
|
|
50
|
+
github_project: 'fsaragoca/fastlane-plugin-changelog_generator',
|
|
51
|
+
github_api_token: 'GITHUB_API_TOKEN',
|
|
52
|
+
base_branch: 'master',
|
|
53
|
+
template_path: 'fastlane/changelog_template.erb',
|
|
54
|
+
template: 'YOUR_ERB_TEMPLATE', # Must provide either template or template_path
|
|
55
|
+
tag_a: 'v0.2.0',
|
|
56
|
+
tag_b: 'v0.1.0', # Optional, will be prompted if not provided
|
|
57
|
+
skip_tag_b: true, # Optional, defaults to false
|
|
58
|
+
output_path: 'RELEASE_0.2.0.md' # Optional
|
|
59
|
+
)
|
|
60
|
+
```
|
|
20
61
|
|
|
21
62
|
## Run tests for this plugin
|
|
22
63
|
|
|
@@ -2,7 +2,7 @@ module Fastlane
|
|
|
2
2
|
module Helper
|
|
3
3
|
class ChangelogGeneratorHelper
|
|
4
4
|
def self.git_tags(limit = nil)
|
|
5
|
-
tags = `git tag --sort
|
|
5
|
+
tags = `git tag | xargs -I@ git log --format=format:"%ai @%n" -1 @ | sort | awk '{print $4}'`.split("\n").reverse
|
|
6
6
|
tags = tags.take(limit) if limit
|
|
7
7
|
tags
|
|
8
8
|
end
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: fastlane-plugin-changelog_generator
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.2.
|
|
4
|
+
version: 0.2.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Fernando Saragoca
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2016-12-
|
|
11
|
+
date: 2016-12-14 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: octokit
|