release-notes 4.0.0.pre → 4.0.0
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 +4 -4
- data/CHANGELOG.md +6 -0
- data/README.md +19 -0
- data/lib/release/notes/cmd.rb +2 -2
- data/lib/release/notes/tag.rb +1 -1
- data/lib/release/notes/tasks/install.rake +2 -2
- data/lib/release/notes/version.rb +1 -1
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 8afe4fa6570614d28e954240401c34a243d8e7a2d59295a21a6ae0281d1e989c
|
4
|
+
data.tar.gz: 2c8fc399972467ca46ed39ac548114d6b5a2b0bf839158cad3563dea65afdd2d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4b52ae2a3b24afbc08fb114d828c53208795fed381e8be0980bdb1d252fd9eee2f7520f69b491ed8c5f56127854b17d7e892c2bbdc2f1daca5dc72527953e1be
|
7
|
+
data.tar.gz: 39c2bc7646ebaf905fdaf069546418a296098e67fff64f182bf61d022ec38a2e9be7fe03164588d77c6166e788bc939b11af6b85dca8240c79778366f7e25fa3
|
data/CHANGELOG.md
CHANGED
data/README.md
CHANGED
@@ -209,6 +209,24 @@ $ bundle binstubs release-notes
|
|
209
209
|
|
210
210
|
and run
|
211
211
|
|
212
|
+
```
|
213
|
+
$ exe/release-notes help generate
|
214
|
+
|
215
|
+
Usage:
|
216
|
+
release-notes generate
|
217
|
+
|
218
|
+
Options:
|
219
|
+
-t, [--tag=TAG] # The latest tag to use on the file title if the tag is not yet pushed
|
220
|
+
-r, [--force-rewrite], [--no-force-rewrite] # Force release-notes to look at all previous tags and rewrite the output file
|
221
|
+
-i, [--ignore-head], [--no-ignore-head] # If updating your changelog and you don't want the latest commits from the last tag to HEAD in a single instance of running, set to true
|
222
|
+
|
223
|
+
Generate release notes
|
224
|
+
|
225
|
+
```
|
226
|
+
|
227
|
+
some sample ideas:
|
228
|
+
|
229
|
+
|
212
230
|
```sh
|
213
231
|
# make sure to pass your tag if updating before you've pushed the latest tag
|
214
232
|
$ bin/release-notes -t v0.2.0
|
@@ -218,6 +236,7 @@ $ bin/release-notes --ignore-head
|
|
218
236
|
$ bin/release-notes --force-rewrite
|
219
237
|
```
|
220
238
|
|
239
|
+
|
221
240
|
## Important Notes
|
222
241
|
|
223
242
|
- Your project must tag releases(release-notes uses the tag date to output the changes)
|
data/lib/release/notes/cmd.rb
CHANGED
@@ -19,9 +19,9 @@ module Release
|
|
19
19
|
"from the last tag to HEAD in a single "\
|
20
20
|
"instance of running, set to true"
|
21
21
|
def generate
|
22
|
-
|
22
|
+
$stderr.puts "=> Generating release notes..." # rubocop:disable Style/StderrPuts
|
23
23
|
Log.new(options).perform
|
24
|
-
|
24
|
+
$stderr.puts "=> Done!" # rubocop:disable Style/StderrPuts
|
25
25
|
end
|
26
26
|
end
|
27
27
|
end
|
data/lib/release/notes/tag.rb
CHANGED
@@ -6,10 +6,10 @@ namespace :"release:notes" do
|
|
6
6
|
config_file = File.expand_path("../../../generators/release/notes/install/templates/release_notes.rb", __dir__)
|
7
7
|
|
8
8
|
if File.exist?("./config/release_notes.rb")
|
9
|
-
|
9
|
+
$stderr.puts "=> [ skipping ] config/release_notes.rb already exists" # rubocop:disable Style/StderrPuts
|
10
10
|
else
|
11
11
|
FileUtils.cp(config_file, "./config/release_notes.rb")
|
12
|
-
|
12
|
+
$stderr.puts "=> config/release_notes.rb created" # rubocop:disable Style/StderrPuts
|
13
13
|
end
|
14
14
|
end
|
15
15
|
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: release-notes
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 4.0.0
|
4
|
+
version: 4.0.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Drew Monroe
|
8
8
|
autorequire:
|
9
9
|
bindir: exe
|
10
10
|
cert_chain: []
|
11
|
-
date: 2019-
|
11
|
+
date: 2019-02-04 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: activesupport
|
@@ -159,9 +159,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
159
159
|
version: '0'
|
160
160
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
161
161
|
requirements:
|
162
|
-
- - "
|
162
|
+
- - ">="
|
163
163
|
- !ruby/object:Gem::Version
|
164
|
-
version:
|
164
|
+
version: '0'
|
165
165
|
requirements: []
|
166
166
|
rubyforge_project:
|
167
167
|
rubygems_version: 2.7.3
|