release-notes 1.0.0.pre → 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/PULL_REQUEST_TEMPLATE.md +1 -1
- data/CONTRIBUTING.md +38 -0
- data/README.md +3 -4
- data/bin/test +3 -0
- data/lib/generators/release/notes/install/templates/release_notes.rb +98 -0
- data/lib/release/notes/link.rb +1 -1
- data/lib/release/notes/log.rb +1 -2
- data/lib/release/notes/version.rb +1 -1
- data/lib/release/notes/write.rb +1 -3
- metadata +5 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 0bb986c1d6491539b7aae9abb3b1a789c0521aced3843e2bb0c3fcad78edc3b4
|
4
|
+
data.tar.gz: 5ff8bfd9a11045be80e1e90efa107b7ef53a1f4bd0af457d5faff490c5b58cbf
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1c0687d912826f94ce941c65bdb8a6709c796a02a2554312aa2ed109672a663316c06ea403d5fc2a6bcce0d2d8a59c6020935bc7a542c005d48dd8d76f6a70de
|
7
|
+
data.tar.gz: 70e57e14fac4daf6c6520298c93a6c38b502db0b66fd01fd5439addd662f15eb3adc73ccdae4488b71cb7c1b59679991678eb572c63be57f79a15ce69e46f20e
|
data/CONTRIBUTING.md
ADDED
@@ -0,0 +1,38 @@
|
|
1
|
+
# Contributing
|
2
|
+
|
3
|
+
First, thanks for wanting to contribute. You’re awesome! :heart:
|
4
|
+
|
5
|
+
## Bugs
|
6
|
+
|
7
|
+
Think you’ve discovered a bug?
|
8
|
+
|
9
|
+
1. Search existing issues to see if it’s been reported.
|
10
|
+
2. Try the `master` branch to make sure it hasn’t been fixed.
|
11
|
+
|
12
|
+
```rb
|
13
|
+
gem "release-notes", git: "git@github.com:n2publishing/release-notes.git"
|
14
|
+
```
|
15
|
+
|
16
|
+
If the above steps don’t help, create an issue.
|
17
|
+
|
18
|
+
- For exceptions, include the complete backtrace.
|
19
|
+
|
20
|
+
## New Features
|
21
|
+
|
22
|
+
If you’d like to discuss a new feature, create an issue and add the `Enhancement` GH label.
|
23
|
+
|
24
|
+
## Pull Requests
|
25
|
+
|
26
|
+
Create a pull request against master. A few tips:
|
27
|
+
|
28
|
+
- Keep changes to a minimum. If you have multiple features or fixes, submit multiple pull requests.
|
29
|
+
- Follow the existing style. The code should read like it’s written by a single person.
|
30
|
+
- Add one or more tests if possible. Make sure existing tests pass with:
|
31
|
+
|
32
|
+
```sh
|
33
|
+
bin/test
|
34
|
+
```
|
35
|
+
|
36
|
+
Feel free to open an issue to get feedback on your idea before spending too much time on it.
|
37
|
+
|
38
|
+
---
|
data/README.md
CHANGED
@@ -77,6 +77,7 @@ Release::Notes.configure do |config|
|
|
77
77
|
config.link_to_humanize = %w()
|
78
78
|
config.link_to_sites = %w()
|
79
79
|
config.timezone = 'America/New_York'
|
80
|
+
config.prettify_messages = true
|
80
81
|
config.force_rewrite = false
|
81
82
|
end
|
82
83
|
```
|
@@ -176,13 +177,11 @@ includes this last commit.
|
|
176
177
|
|
177
178
|
## Development
|
178
179
|
|
179
|
-
After checking out the repo, run `bin/setup` to install dependencies. Then, run `
|
180
|
-
|
181
|
-
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
|
180
|
+
After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
182
181
|
|
183
182
|
## Contributing
|
184
183
|
|
185
|
-
Bug reports and pull requests are welcome on GitHub at https://github.com/dvmonroe/release-notes. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [
|
184
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/dvmonroe/release-notes. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributing Guide](https://github.com/dvmonroe/release-notes/CONTRIBUTING.md).
|
186
185
|
|
187
186
|
## License
|
188
187
|
|
data/bin/test
ADDED
@@ -1,22 +1,120 @@
|
|
1
1
|
# frozen_string_literal: true
|
2
2
|
|
3
3
|
Release::Notes.configure do |config|
|
4
|
+
# The absolute path of your generated log.
|
5
|
+
# Defaults to `./RELEASE_NOTES.md`.
|
6
|
+
# @return [String]
|
4
7
|
# config.output_file = './RELEASE_NOTES.md'
|
8
|
+
|
9
|
+
# The absolute path of the temporary generated log.
|
10
|
+
# Defaults to `./release-notes.tmp.md`.
|
11
|
+
# @return [String]
|
5
12
|
# config.temp_file = './release-notes.tmp.md'
|
13
|
+
|
14
|
+
# Determines whether to print commits with more than one parent.
|
15
|
+
# Defaults to `false`. For more, see
|
16
|
+
# [Git Log Docs](https://git-scm.com/docs/git-log)
|
17
|
+
# @return [Boolean]
|
6
18
|
# config.include_merges = false
|
19
|
+
|
20
|
+
# Match the regular expression limiting patterns without regard to letter case
|
21
|
+
# when printing your git log.
|
22
|
+
# Defaults to `true`. For more, see
|
23
|
+
# [Git Log Docs](https://git-scm.com/docs/git-log)
|
24
|
+
# @return [Boolean]
|
7
25
|
# config.ignore_case = true
|
26
|
+
|
27
|
+
# Allows you to specify what information you want to print from your git log
|
28
|
+
# Defaults to `%s` for subject. For more, see
|
29
|
+
# [Git Log Docs](https://git-scm.com/docs/git-log)
|
30
|
+
# @return [String]
|
8
31
|
# config.log_format = '- %s'
|
32
|
+
|
33
|
+
# Consider the limiting patterns to be extended regular expressions patterns
|
34
|
+
# when printing your git log.
|
35
|
+
# Defaults to `true`. For more, see
|
36
|
+
# [Git Log Docs](https://git-scm.com/docs/git-log)
|
37
|
+
# @return [Boolean]
|
9
38
|
# config.extended_regex = true
|
39
|
+
|
40
|
+
# Allows you to specify what information you want to print from your git log
|
41
|
+
# Defaults to `%s` for subject. For more, see
|
42
|
+
# [Git Log Docs](https://git-scm.com/docs/git-log)
|
43
|
+
# @return [String]
|
10
44
|
# config.bug_labels = %w(Fix Update)
|
45
|
+
|
46
|
+
# Controls the labels grepped for in your commit subjects that will
|
47
|
+
# be add under you feature title
|
48
|
+
# Defaults to `%w(Add Create)`.
|
49
|
+
# @return [Array]
|
11
50
|
# config.feature_labels = %w(Add Create)
|
51
|
+
|
52
|
+
# Controls the labels grepped for in your commit subjects that will
|
53
|
+
# be add under you miscellaneous title
|
54
|
+
# Defaults to `%w(Refactor)`.
|
55
|
+
# @return [Array]
|
12
56
|
# config.misc_labels = %w(Refactor)
|
57
|
+
|
58
|
+
# Controls the title used in your generated log for all bugs listed
|
59
|
+
# Defaults to `**Fixed bugs:**`.
|
60
|
+
# @return [String]
|
13
61
|
# config.bug_title = '**Fixed bugs:**'
|
62
|
+
|
63
|
+
# Controls the title used in your generated log for all features listed
|
64
|
+
# Defaults to `**Implemented enhancements:**`.
|
65
|
+
# @return [String]
|
14
66
|
# config.feature_title = '**Implemented enhancements:**'
|
67
|
+
|
68
|
+
# Controls the title used in your generated log for all misc commits listed
|
69
|
+
# Defaults to `**Miscellaneous:**`.
|
70
|
+
# @return [String]
|
15
71
|
# config.misc_title = '**Miscellaneous:**'
|
72
|
+
|
73
|
+
# Controls the title used in your generated log for all commits listed
|
74
|
+
# Defaults to `**Other:**`.
|
75
|
+
# @return [String]
|
16
76
|
# config.log_all_title = '**Other:**'
|
77
|
+
|
78
|
+
# Controls whether all logs that do not match the other labels are listed
|
79
|
+
# Defaults to `false`
|
80
|
+
# @return [Boolean]
|
17
81
|
# config.log_all = false
|
82
|
+
|
83
|
+
# The labels grepped for in your commit subject that you want to linkify.
|
84
|
+
# The index within the array must match the index for the site
|
85
|
+
# in `:link_to_humanize` and `:link_to_sites`.
|
86
|
+
# Defaults to `[]`.
|
87
|
+
# @return [Array]
|
18
88
|
# config.link_to_labels = %w()
|
89
|
+
|
90
|
+
# The humanized output that you'd like to represent the associated `:link_to_label`
|
91
|
+
# The index within the array must match the index for the site
|
92
|
+
# in `:link_to_label` and `:link_to_sites`.
|
93
|
+
# Defaults to `[]`.
|
94
|
+
# @return [Array]
|
19
95
|
# config.link_to_humanize = %w()
|
96
|
+
|
97
|
+
# The url for the site that you'd like to represent the associated `:link_to_label`
|
98
|
+
# The index within the array must match the index for the site
|
99
|
+
# in `:link_to_label` and `:link_to_humanize`.
|
100
|
+
# Defaults to `[]`.
|
101
|
+
# @return [Array]
|
20
102
|
# config.link_to_sites = %w()
|
103
|
+
|
104
|
+
# Sets the timezone that should be used for setting the date.
|
105
|
+
# Defaults to `America/New_York`. For more, see
|
106
|
+
# [ActiveSupport Time Zones](http://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html)
|
107
|
+
# @return [String]
|
21
108
|
# config.timezone = 'America/New_York'
|
109
|
+
|
110
|
+
# Controls whether your commit subject labels should be removed from the final
|
111
|
+
# ouput of your message on the generated log.
|
112
|
+
# Defaults to `true`.
|
113
|
+
# @return [Boolean]
|
114
|
+
# config.prettify_messages = true
|
115
|
+
|
116
|
+
# Controls whether to rewrite the output file or append to it.
|
117
|
+
# Defaults to `false`.
|
118
|
+
# @return [Boolean]
|
119
|
+
# config.force_rewrite = false
|
22
120
|
end
|
data/lib/release/notes/link.rb
CHANGED
data/lib/release/notes/log.rb
CHANGED
@@ -43,8 +43,7 @@ module Release
|
|
43
43
|
end
|
44
44
|
|
45
45
|
# @api private
|
46
|
-
def copy_single_tag_of_activity(tag_from:, tag_to:
|
47
|
-
tag_to ||= "HEAD"
|
46
|
+
def copy_single_tag_of_activity(tag_from:, tag_to: "HEAD")
|
48
47
|
[features, bugs, misc].each_with_index do |regex, i|
|
49
48
|
log = system_call(tag_from: tag_from, tag_to: tag_to, label: regex, log_all: false)
|
50
49
|
digest_title(title: titles[i], log_message: log) if log.present?
|
data/lib/release/notes/write.rb
CHANGED
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: release-notes
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.0.0
|
4
|
+
version: 1.0.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Drew Monroe
|
@@ -95,12 +95,14 @@ files:
|
|
95
95
|
- ".travis.yml"
|
96
96
|
- ".yardopts"
|
97
97
|
- CODE_OF_CONDUCT.md
|
98
|
+
- CONTRIBUTING.md
|
98
99
|
- Gemfile
|
99
100
|
- LICENSE.txt
|
100
101
|
- README.md
|
101
102
|
- Rakefile
|
102
103
|
- bin/console
|
103
104
|
- bin/setup
|
105
|
+
- bin/test
|
104
106
|
- lib/generators/release/notes/install/install_generator.rb
|
105
107
|
- lib/generators/release/notes/install/templates/README
|
106
108
|
- lib/generators/release/notes/install/templates/release_notes.rb
|
@@ -133,9 +135,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
133
135
|
version: '0'
|
134
136
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
135
137
|
requirements:
|
136
|
-
- - "
|
138
|
+
- - ">="
|
137
139
|
- !ruby/object:Gem::Version
|
138
|
-
version:
|
140
|
+
version: '0'
|
139
141
|
requirements: []
|
140
142
|
rubyforge_project:
|
141
143
|
rubygems_version: 2.7.6
|