milestoner 10.0.0 → 10.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- checksums.yaml.gz.sig +4 -2
- data.tar.gz.sig +0 -0
- data/{LICENSE.md → LICENSE.adoc} +29 -30
- data/README.adoc +226 -0
- data/bin/milestoner +1 -1
- data/lib/milestoner/cli.rb +3 -3
- data/lib/milestoner/git/kit.rb +1 -1
- data/lib/milestoner/identity.rb +4 -15
- data/lib/milestoner/tagger.rb +2 -2
- metadata +65 -36
- metadata.gz.sig +0 -0
- data/README.md +0 -204
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c315f1ddc5e1602eec6678ea4d9940de8cc654ecd89088765bb26c25adc0c550
|
4
|
+
data.tar.gz: 82a920c588f7bafc61b94d75539a9cb716a41c78b33e028ec7e0f5626136f97b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4abf959396e4398f75a5f845177e6bc882462ce4b7d94944b8e698f2ffa0b4317cbd020a9666c6e11831748d23d0f372470ec150bde177c723b60db636ad6a17
|
7
|
+
data.tar.gz: 78f0b7cff488bdce3b49598bdd5d1fd4afb04f8cc6ff8bc6fe03f7466dd3aa1394ae76013fc2bacefcada5796f39392a58fe52d6959662d0222b4a243df17e27
|
checksums.yaml.gz.sig
CHANGED
@@ -1,2 +1,4 @@
|
|
1
|
-
|
2
|
-
��
|
1
|
+
0�v�A�!�b$��_$��4ev"T��!��W�����G�ٹX�!5��rO�v5�>�� ��������A�<SeS̡��9!����a�.a�Lu{
|
2
|
+
��c]>?��P�B@R�p�Y?2O
|
3
|
+
��R�}��nr��OB�k
|
4
|
+
��>'���6�T�"�s��2/`8f��p̾�c@Sm��O^�)7i�#�QG�H����cͿ���v�U��3��kP�|���b�V��K8�t%��;ISMUl&9�5?��(���[�e,
|
data.tar.gz.sig
CHANGED
Binary file
|
data/{LICENSE.md → LICENSE.adoc}
RENAMED
@@ -1,4 +1,4 @@
|
|
1
|
-
|
1
|
+
= Apache License
|
2
2
|
|
3
3
|
Version 2.0, January 2004
|
4
4
|
|
@@ -6,7 +6,7 @@ http://www.apache.org/licenses
|
|
6
6
|
|
7
7
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
8
8
|
|
9
|
-
|
9
|
+
== 1. Definitions
|
10
10
|
|
11
11
|
"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by
|
12
12
|
Sections 1 through 9 of this document.
|
@@ -54,14 +54,14 @@ Contribution."
|
|
54
54
|
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a
|
55
55
|
Contribution has been received by Licensor and subsequently incorporated within the Work.
|
56
56
|
|
57
|
-
|
57
|
+
== 2. Grant of Copyright License
|
58
58
|
|
59
59
|
Subject to the terms and conditions of this License, each Contributor hereby grants to You a
|
60
60
|
perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to
|
61
61
|
reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and
|
62
62
|
distribute the Work and such Derivative Works in Source or Object form.
|
63
63
|
|
64
|
-
|
64
|
+
== 3. Grant of Patent License
|
65
65
|
|
66
66
|
Subject to the terms and conditions of this License, each Contributor hereby grants to You a
|
67
67
|
perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this
|
@@ -74,39 +74,38 @@ a Contribution incorporated within the Work constitutes direct or contributory p
|
|
74
74
|
then any patent licenses granted to You under this License for that Work shall terminate as of the
|
75
75
|
date such litigation is filed.
|
76
76
|
|
77
|
-
|
77
|
+
== 4. Redistribution
|
78
78
|
|
79
79
|
You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with
|
80
80
|
or without modifications, and in Source or Object form, provided that You meet the following
|
81
81
|
conditions:
|
82
82
|
|
83
|
-
|
83
|
+
. You must give any other recipients of the Work or Derivative Works a copy of this License; and
|
84
84
|
|
85
|
-
|
86
|
-
|
85
|
+
. You must cause any modified files to carry prominent notices stating that You changed the files;
|
86
|
+
and
|
87
87
|
|
88
|
-
|
89
|
-
|
90
|
-
|
88
|
+
. You must retain, in the Source form of any Derivative Works that You distribute, all copyright,
|
89
|
+
patent, trademark, and attribution notices from the Source form of the Work, excluding those
|
90
|
+
notices that do not pertain to any part of the Derivative Works; and
|
91
91
|
|
92
|
-
|
93
|
-
|
94
|
-
|
95
|
-
|
96
|
-
|
97
|
-
|
98
|
-
|
99
|
-
|
100
|
-
|
101
|
-
|
102
|
-
construed as modifying the License.
|
92
|
+
. If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works
|
93
|
+
that You distribute must include a readable copy of the attribution notices contained within such
|
94
|
+
NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in
|
95
|
+
at least one of the following places: within a NOTICE text file distributed as part of the
|
96
|
+
Derivative Works; within the Source form or documentation, if provided along with the Derivative
|
97
|
+
Works; or, within a display generated by the Derivative Works, if and wherever such third-party
|
98
|
+
notices normally appear. The contents of the NOTICE file are for informational purposes only and
|
99
|
+
do not modify the License. You may add Your own attribution notices within Derivative Works that
|
100
|
+
You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such
|
101
|
+
additional attribution notices cannot be construed as modifying the License.
|
103
102
|
|
104
103
|
You may add Your own copyright statement to Your modifications and may provide additional or
|
105
104
|
different license terms and conditions for use, reproduction, or distribution of Your modifications,
|
106
105
|
or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of
|
107
106
|
the Work otherwise complies with the conditions stated in this License.
|
108
107
|
|
109
|
-
|
108
|
+
== 5. Submission of Contributions
|
110
109
|
|
111
110
|
Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the
|
112
111
|
Work by You to the Licensor shall be under the terms and conditions of this License, without any
|
@@ -114,13 +113,13 @@ additional terms or conditions. Notwithstanding the above, nothing herein shall
|
|
114
113
|
the terms of any separate license agreement you may have executed with Licensor regarding such
|
115
114
|
Contributions.
|
116
115
|
|
117
|
-
|
116
|
+
== 6. Trademarks
|
118
117
|
|
119
118
|
This License does not grant permission to use the trade names, trademarks, service marks, or product
|
120
119
|
names of the Licensor, except as required for reasonable and customary use in describing the origin
|
121
120
|
of the Work and reproducing the content of the NOTICE file.
|
122
121
|
|
123
|
-
|
122
|
+
== 7. Disclaimer of Warranty
|
124
123
|
|
125
124
|
Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each
|
126
125
|
Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
@@ -129,7 +128,7 @@ TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. Y
|
|
129
128
|
responsible for determining the appropriateness of using or redistributing the Work and assume any
|
130
129
|
risks associated with Your exercise of permissions under this License.
|
131
130
|
|
132
|
-
|
131
|
+
== 8. Limitation of Liability
|
133
132
|
|
134
133
|
In no event and under no legal theory, whether in tort (including negligence), contract, or
|
135
134
|
otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or
|
@@ -139,7 +138,7 @@ License or out of the use or inability to use the Work (including but not limite
|
|
139
138
|
loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial
|
140
139
|
damages or losses), even if such Contributor has been advised of the possibility of such damages.
|
141
140
|
|
142
|
-
|
141
|
+
== 9. Accepting Warranty or Additional Liability
|
143
142
|
|
144
143
|
While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee
|
145
144
|
for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights
|
@@ -151,11 +150,11 @@ additional liability.
|
|
151
150
|
|
152
151
|
END OF TERMS AND CONDITIONS
|
153
152
|
|
154
|
-
Copyright 2015
|
153
|
+
Copyright 2015 link:https://www.alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].
|
155
154
|
|
156
155
|
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in
|
157
|
-
compliance with the License. You may obtain a
|
158
|
-
the License.
|
156
|
+
compliance with the License. You may obtain a link:https://www.apache.org/licenses/LICENSE-2.0[copy]
|
157
|
+
of the License.
|
159
158
|
|
160
159
|
Unless required by applicable law or agreed to in writing, software distributed under the License is
|
161
160
|
distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
data/README.adoc
ADDED
@@ -0,0 +1,226 @@
|
|
1
|
+
:toc: macro
|
2
|
+
:toclevels: 5
|
3
|
+
:figure-caption!:
|
4
|
+
|
5
|
+
= Milestoner
|
6
|
+
|
7
|
+
[link=http://badge.fury.io/rb/milestoner]
|
8
|
+
image::https://badge.fury.io/rb/milestoner.svg[Gem Version]
|
9
|
+
[link=https://circleci.com/gh/bkuhlmann/milestoner]
|
10
|
+
image::https://circleci.com/gh/bkuhlmann/milestoner.svg?style=svg[Circle CI Status]
|
11
|
+
|
12
|
+
A command line interface for crafting Git repository milestones (also known as _tags_).
|
13
|
+
|
14
|
+
toc::[]
|
15
|
+
|
16
|
+
== Features
|
17
|
+
|
18
|
+
* Uses link:https://www.alchemists.io/projects/versionaire[Versionaire] for
|
19
|
+
link:https://semver.org[Semantic Versioning].
|
20
|
+
** Format: `+<major>.<minor>.<patch>+`.
|
21
|
+
** Example: `+0.1.0+`.
|
22
|
+
* Ensures Git commits since last tag (or initialization of repository) are included.
|
23
|
+
* Ensures Git commit messages are grouped by prefix, in order defined. For more details, see
|
24
|
+
link:https://www.alchemists.io/projects/git-cop/#_commit_subject_prefix[Git Cop Subject Prefix]
|
25
|
+
for details. Defaults (can be customized):
|
26
|
+
** Fixed
|
27
|
+
** Added
|
28
|
+
** Updated
|
29
|
+
** Removed
|
30
|
+
** Refactored
|
31
|
+
* Ensures Git commit merge messages are excluded.
|
32
|
+
* Ensures Git commit messages are alphabetically sorted.
|
33
|
+
* Ensures duplicate Git commit messages are removed (if any).
|
34
|
+
* Ensures Git commit messages are sanitized by removing extra spaces and `+[ci skip]+` text within
|
35
|
+
each Git tag message.
|
36
|
+
* Provides optional security for signing Git tags with https://www.gnupg.org[GnuPG] signing key.
|
37
|
+
|
38
|
+
== Screencasts
|
39
|
+
|
40
|
+
[link=https://www.alchemists.io/screencasts/milestoner]
|
41
|
+
image::https://www.alchemists.io/images/screencasts/milestoner/cover.svg[Screencast,600,240,role=focal_point]
|
42
|
+
|
43
|
+
== Requirements
|
44
|
+
|
45
|
+
. A UNIX-based system.
|
46
|
+
. https://www.ruby-lang.org[Ruby].
|
47
|
+
. https://www.gnupg.org[GnuPG].
|
48
|
+
|
49
|
+
== Setup
|
50
|
+
|
51
|
+
To install, run:
|
52
|
+
|
53
|
+
[source,bash]
|
54
|
+
----
|
55
|
+
gem install milestoner
|
56
|
+
----
|
57
|
+
|
58
|
+
== Usage
|
59
|
+
|
60
|
+
=== Command Line Interface (CLI)
|
61
|
+
|
62
|
+
From the command line, type: `+milestoner help+`
|
63
|
+
|
64
|
+
....
|
65
|
+
milestoner -C, [--commits] # Show commits for next milestone.
|
66
|
+
milestoner -P, [--publish=VERSION] # Tag and push milestone to remote repository.
|
67
|
+
milestoner -c, [--config] # Manage gem configuration.
|
68
|
+
milestoner -h, [--help=COMMAND] # Show this message or get help for a command.
|
69
|
+
milestoner -p, [--push=VERSION] # Push local tag to remote repository.
|
70
|
+
milestoner -t, [--tag=VERSION] # Tag local repository with new version.
|
71
|
+
milestoner -v, [--version] # Show gem version.
|
72
|
+
....
|
73
|
+
|
74
|
+
For config options, type: `+milestoner help --config+`
|
75
|
+
|
76
|
+
....
|
77
|
+
-e, [--edit], [--no-edit] # Edit gem configuration.
|
78
|
+
-i, [--info], [--no-info] # Print gem configuration info.
|
79
|
+
....
|
80
|
+
|
81
|
+
For tag options, type: `+milestoner help --tag+`
|
82
|
+
|
83
|
+
....
|
84
|
+
-s, [--sign], [--no-sign] # Sign tag with GPG key.
|
85
|
+
....
|
86
|
+
|
87
|
+
For publish options, type: `+milestoner help --publish+`
|
88
|
+
|
89
|
+
....
|
90
|
+
-s, [--sign], [--no-sign] # Sign tag with GPG key.
|
91
|
+
....
|
92
|
+
|
93
|
+
When using Milestoner, the `+--publish+` command is intended to be the only command necessary for
|
94
|
+
publishing a new release as it handles all of the steps necessary for tagging and pushing a new
|
95
|
+
milestone. Should individual steps be needed, then the `+--tag+` and `+--push+` options are
|
96
|
+
available.
|
97
|
+
|
98
|
+
=== Customization
|
99
|
+
|
100
|
+
This gem can be configured via a global configuration:
|
101
|
+
|
102
|
+
....
|
103
|
+
~/.config/milestoner/configuration.yml
|
104
|
+
....
|
105
|
+
|
106
|
+
It can also be configured via https://www.alchemists.io/projects/xdg[XDG] environment variables.
|
107
|
+
|
108
|
+
The default configuration is as follows:
|
109
|
+
|
110
|
+
[source,yaml]
|
111
|
+
----
|
112
|
+
:git_commit_prefixes:
|
113
|
+
- Fixed
|
114
|
+
- Added
|
115
|
+
- Updated
|
116
|
+
- Removed
|
117
|
+
- Refactored
|
118
|
+
:git_tag_sign: false
|
119
|
+
----
|
120
|
+
|
121
|
+
Feel free to take this default configuration, modify, and save as your own custom
|
122
|
+
`+configuration.yml+`.
|
123
|
+
|
124
|
+
The `+configuration.yml+` file can be configured as follows:
|
125
|
+
|
126
|
+
* `+git_commit_prefixes+`: Should the default prefixes not be desired, you can define Git commit
|
127
|
+
prefixes that match your style. _NOTE: Prefix order is important with the first prefix defined
|
128
|
+
taking precedence over the second and so forth._ Special characters are allowed for prefixes but
|
129
|
+
should be enclosed in quotes. To disable prefix usage completely, use an empty array. Example:
|
130
|
+
`+:git_commit_prefixes: []+`.
|
131
|
+
* `+git_tag_sign+`: Defaults to `+false+` but can be enabled by setting to `+true+`. When enabled, a
|
132
|
+
Git tag will require GPG signing for enhanced security and include a signed signature as part of the
|
133
|
+
Git tag. This is useful for public milestones where the author of a milestone can be verified to
|
134
|
+
ensure milestone integrity/security.
|
135
|
+
|
136
|
+
== Security
|
137
|
+
|
138
|
+
To securely sign your Git tags, install and configure https://www.gnupg.org[GPG]:
|
139
|
+
|
140
|
+
[source,bash]
|
141
|
+
----
|
142
|
+
brew install gpg
|
143
|
+
gpg --gen-key
|
144
|
+
----
|
145
|
+
|
146
|
+
When creating your GPG key, choose these settings:
|
147
|
+
|
148
|
+
* Key kind: RSA and RSA (default)
|
149
|
+
* Key size: 4096
|
150
|
+
* Key validity: 0
|
151
|
+
* Real Name: `+<your name>+`
|
152
|
+
* Email: `+<your email>+`
|
153
|
+
* Passphrase: `+<your passphrase>+`
|
154
|
+
|
155
|
+
To obtain your key, run the following and take the part after the forward slash:
|
156
|
+
|
157
|
+
....
|
158
|
+
gpg --list-keys | grep pub
|
159
|
+
....
|
160
|
+
|
161
|
+
Add your key to your global Git configuration in the `+[user]+` section. Example:
|
162
|
+
|
163
|
+
....
|
164
|
+
[user]
|
165
|
+
signingkey = <your GPG key>
|
166
|
+
....
|
167
|
+
|
168
|
+
Now, when publishing a new milestone (i.e. `+milestoner --publish <version> --sign+`), signing of
|
169
|
+
your Git tag will happen automatically. You will be prompted for the GPG Passphrase each time but
|
170
|
+
that is to be expected.
|
171
|
+
|
172
|
+
== Development
|
173
|
+
|
174
|
+
To contribute, run:
|
175
|
+
|
176
|
+
[source,bash]
|
177
|
+
----
|
178
|
+
git clone https://github.com/bkuhlmann/milestoner.git
|
179
|
+
cd milestoner
|
180
|
+
bin/setup
|
181
|
+
----
|
182
|
+
|
183
|
+
You can also use the IRB console for direct access to all objects:
|
184
|
+
|
185
|
+
[source,bash]
|
186
|
+
----
|
187
|
+
bin/console
|
188
|
+
----
|
189
|
+
|
190
|
+
== Tests
|
191
|
+
|
192
|
+
To test, run:
|
193
|
+
|
194
|
+
[source,bash]
|
195
|
+
----
|
196
|
+
bundle exec spec
|
197
|
+
----
|
198
|
+
|
199
|
+
== Versioning
|
200
|
+
|
201
|
+
Read link:https://semver.org[Semantic Versioning] for details. Briefly, it means:
|
202
|
+
|
203
|
+
* Major (X.y.z) - Incremented for any backwards incompatible public API changes.
|
204
|
+
* Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
|
205
|
+
* Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.
|
206
|
+
|
207
|
+
== Code of Conduct
|
208
|
+
|
209
|
+
Please note that this project is released with a link:CODE_OF_CONDUCT.adoc[CODE OF CONDUCT]. By
|
210
|
+
participating in this project you agree to abide by its terms.
|
211
|
+
|
212
|
+
== Contributions
|
213
|
+
|
214
|
+
Read link:CONTRIBUTING.adoc[CONTRIBUTING] for details.
|
215
|
+
|
216
|
+
== License
|
217
|
+
|
218
|
+
Read link:LICENSE.adoc[LICENSE] for details.
|
219
|
+
|
220
|
+
== History
|
221
|
+
|
222
|
+
Read link:CHANGES.adoc[CHANGES] for details.
|
223
|
+
|
224
|
+
== Credits
|
225
|
+
|
226
|
+
Engineered by link:https://www.alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].
|
data/bin/milestoner
CHANGED
data/lib/milestoner/cli.rb
CHANGED
@@ -9,10 +9,10 @@ module Milestoner
|
|
9
9
|
class CLI < Thor
|
10
10
|
include Thor::Actions
|
11
11
|
|
12
|
-
package_name Identity
|
12
|
+
package_name Identity::VERSION_LABEL
|
13
13
|
|
14
14
|
def self.configuration
|
15
|
-
Runcom::Config.new Identity.
|
15
|
+
Runcom::Config.new "#{Identity::NAME}/configuration.yml",
|
16
16
|
defaults: {
|
17
17
|
git_commit_prefixes: %w[Fixed Added Updated Removed Refactored],
|
18
18
|
git_tag_sign: false
|
@@ -100,7 +100,7 @@ module Milestoner
|
|
100
100
|
desc "-v, [--version]", "Show gem version."
|
101
101
|
map %w[-v --version] => :version
|
102
102
|
def version
|
103
|
-
say Identity
|
103
|
+
say Identity::VERSION_LABEL
|
104
104
|
end
|
105
105
|
|
106
106
|
desc "-h, [--help=COMMAND]", "Show this message or get help for a command."
|
data/lib/milestoner/git/kit.rb
CHANGED
data/lib/milestoner/identity.rb
CHANGED
@@ -3,20 +3,9 @@
|
|
3
3
|
module Milestoner
|
4
4
|
# Gem identity information.
|
5
5
|
module Identity
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
def self.label
|
11
|
-
"Milestoner"
|
12
|
-
end
|
13
|
-
|
14
|
-
def self.version
|
15
|
-
"10.0.0"
|
16
|
-
end
|
17
|
-
|
18
|
-
def self.version_label
|
19
|
-
"#{label} #{version}"
|
20
|
-
end
|
6
|
+
NAME = "milestoner"
|
7
|
+
LABEL = "Milestoner"
|
8
|
+
VERSION = "10.3.0"
|
9
|
+
VERSION_LABEL = "#{LABEL} #{VERSION}"
|
21
10
|
end
|
22
11
|
end
|
data/lib/milestoner/tagger.rb
CHANGED
@@ -80,7 +80,7 @@ module Milestoner
|
|
80
80
|
end
|
81
81
|
|
82
82
|
def git_message
|
83
|
-
%(Version #{@version}
|
83
|
+
%(Version #{@version}\n\n#{commit_list.join "\n"}\n\n)
|
84
84
|
end
|
85
85
|
|
86
86
|
# :reek:BooleanParameter
|
@@ -103,7 +103,7 @@ module Milestoner
|
|
103
103
|
# :reek:BooleanParameter
|
104
104
|
# :reek:TooManyStatements
|
105
105
|
def git_tag sign: false
|
106
|
-
message_file = Tempfile.new Identity
|
106
|
+
message_file = Tempfile.new Identity::NAME
|
107
107
|
File.open(message_file, "w") { |file| file.write git_message }
|
108
108
|
status = system "git tag #{git_options message_file, sign: sign}"
|
109
109
|
fail Errors::Git, "Unable to create tag: #{@version}." unless status
|
metadata
CHANGED
@@ -1,18 +1,18 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: milestoner
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 10.
|
4
|
+
version: 10.3.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Brooke Kuhlmann
|
8
|
-
autorequire:
|
8
|
+
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain:
|
11
11
|
- |
|
12
12
|
-----BEGIN CERTIFICATE-----
|
13
|
-
MIIC/
|
14
|
-
|
15
|
-
|
13
|
+
MIIC/jCCAeagAwIBAgIBAzANBgkqhkiG9w0BAQsFADAlMSMwIQYDVQQDDBpicm9v
|
14
|
+
a2UvREM9YWxjaGVtaXN0cy9EQz1pbzAeFw0yMDAzMTUxNDQ1MzJaFw0yMTAzMTUx
|
15
|
+
NDQ1MzJaMCUxIzAhBgNVBAMMGmJyb29rZS9EQz1hbGNoZW1pc3RzL0RDPWlvMIIB
|
16
16
|
IjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6l1qpXTiomH1RfMRloyw7MiE
|
17
17
|
xyVx/x8Yc3EupdH7uhNaTXQGyORN6aOY//1QXXMHIZ9tW74nZLhesWMSUMYy0XhB
|
18
18
|
brs+KkurHnc9FnEJAbG7ebGvl/ncqZt72nQvaxpDxvuCBHgJAz+8i5wl6FhLw+oT
|
@@ -20,15 +20,15 @@ cert_chain:
|
|
20
20
|
D5vkU0YlAm1r98BymuJlcQ1qdkVEI1d48ph4kcS0S0nv1RiuyVb6TCAR3Nu3VaVq
|
21
21
|
3fPzZKJLZBx67UvXdbdicWPiUR75elI4PXpLIic3xytaF52ZJYyKZCNZJhNwfQID
|
22
22
|
AQABozkwNzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU0nzow9vc
|
23
|
-
2CdikiiE3fJhP/
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
23
|
+
2CdikiiE3fJhP/gY4ggwDQYJKoZIhvcNAQELBQADggEBAIHhAlD3po4sTYqacXaQ
|
24
|
+
XI9jIhrfMy//2PgbHWcETtlJPBeNUbbSNBABcllUHKqYsVDlSvSmss034KSWNR8F
|
25
|
+
bF1GcloicyvcCC4y6IoW4it0COAcdeaaxkxiBSgKdQFpff9REnDlIKK4uQ9lLxIo
|
26
|
+
Y2G5xubiziKZkyfWFuSr67PIjW3Bu673D1JVBArhA1qbgQmYQcy1CkGOjo+iO8Nf
|
27
|
+
7u/QSfBHb+r/bXhKscDgPpnKwbUmvgO2+94zJG9KsrmIydlzYfsD09aXKx0t6Xy4
|
28
|
+
2XV8FRa7/JimI07sPLC13eLY3xd/aYTi85Z782KIA4j0G8XEEWAX0ouBhlXPocZv
|
29
|
+
QWc=
|
30
30
|
-----END CERTIFICATE-----
|
31
|
-
date: 2020-
|
31
|
+
date: 2020-10-18 00:00:00.000000000 Z
|
32
32
|
dependencies:
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: runcom
|
@@ -100,6 +100,34 @@ dependencies:
|
|
100
100
|
- - "~>"
|
101
101
|
- !ruby/object:Gem::Version
|
102
102
|
version: '0.1'
|
103
|
+
- !ruby/object:Gem::Dependency
|
104
|
+
name: gemsmith
|
105
|
+
requirement: !ruby/object:Gem::Requirement
|
106
|
+
requirements:
|
107
|
+
- - "~>"
|
108
|
+
- !ruby/object:Gem::Version
|
109
|
+
version: '14.2'
|
110
|
+
type: :development
|
111
|
+
prerelease: false
|
112
|
+
version_requirements: !ruby/object:Gem::Requirement
|
113
|
+
requirements:
|
114
|
+
- - "~>"
|
115
|
+
- !ruby/object:Gem::Version
|
116
|
+
version: '14.2'
|
117
|
+
- !ruby/object:Gem::Dependency
|
118
|
+
name: git-lint
|
119
|
+
requirement: !ruby/object:Gem::Requirement
|
120
|
+
requirements:
|
121
|
+
- - "~>"
|
122
|
+
- !ruby/object:Gem::Version
|
123
|
+
version: '1.0'
|
124
|
+
type: :development
|
125
|
+
prerelease: false
|
126
|
+
version_requirements: !ruby/object:Gem::Requirement
|
127
|
+
requirements:
|
128
|
+
- - "~>"
|
129
|
+
- !ruby/object:Gem::Version
|
130
|
+
version: '1.0'
|
103
131
|
- !ruby/object:Gem::Dependency
|
104
132
|
name: guard-rspec
|
105
133
|
requirement: !ruby/object:Gem::Requirement
|
@@ -120,28 +148,28 @@ dependencies:
|
|
120
148
|
requirements:
|
121
149
|
- - "~>"
|
122
150
|
- !ruby/object:Gem::Version
|
123
|
-
version: '0.
|
151
|
+
version: '0.13'
|
124
152
|
type: :development
|
125
153
|
prerelease: false
|
126
154
|
version_requirements: !ruby/object:Gem::Requirement
|
127
155
|
requirements:
|
128
156
|
- - "~>"
|
129
157
|
- !ruby/object:Gem::Version
|
130
|
-
version: '0.
|
158
|
+
version: '0.13'
|
131
159
|
- !ruby/object:Gem::Dependency
|
132
160
|
name: pry-byebug
|
133
161
|
requirement: !ruby/object:Gem::Requirement
|
134
162
|
requirements:
|
135
163
|
- - "~>"
|
136
164
|
- !ruby/object:Gem::Version
|
137
|
-
version: '3.
|
165
|
+
version: '3.9'
|
138
166
|
type: :development
|
139
167
|
prerelease: false
|
140
168
|
version_requirements: !ruby/object:Gem::Requirement
|
141
169
|
requirements:
|
142
170
|
- - "~>"
|
143
171
|
- !ruby/object:Gem::Version
|
144
|
-
version: '3.
|
172
|
+
version: '3.9'
|
145
173
|
- !ruby/object:Gem::Dependency
|
146
174
|
name: rake
|
147
175
|
requirement: !ruby/object:Gem::Requirement
|
@@ -162,14 +190,14 @@ dependencies:
|
|
162
190
|
requirements:
|
163
191
|
- - "~>"
|
164
192
|
- !ruby/object:Gem::Version
|
165
|
-
version: '
|
193
|
+
version: '6.0'
|
166
194
|
type: :development
|
167
195
|
prerelease: false
|
168
196
|
version_requirements: !ruby/object:Gem::Requirement
|
169
197
|
requirements:
|
170
198
|
- - "~>"
|
171
199
|
- !ruby/object:Gem::Version
|
172
|
-
version: '
|
200
|
+
version: '6.0'
|
173
201
|
- !ruby/object:Gem::Dependency
|
174
202
|
name: rspec
|
175
203
|
requirement: !ruby/object:Gem::Requirement
|
@@ -190,14 +218,14 @@ dependencies:
|
|
190
218
|
requirements:
|
191
219
|
- - "~>"
|
192
220
|
- !ruby/object:Gem::Version
|
193
|
-
version: '0.
|
221
|
+
version: '0.89'
|
194
222
|
type: :development
|
195
223
|
prerelease: false
|
196
224
|
version_requirements: !ruby/object:Gem::Requirement
|
197
225
|
requirements:
|
198
226
|
- - "~>"
|
199
227
|
- !ruby/object:Gem::Version
|
200
|
-
version: '0.
|
228
|
+
version: '0.89'
|
201
229
|
- !ruby/object:Gem::Dependency
|
202
230
|
name: rubocop-performance
|
203
231
|
requirement: !ruby/object:Gem::Requirement
|
@@ -232,40 +260,40 @@ dependencies:
|
|
232
260
|
requirements:
|
233
261
|
- - "~>"
|
234
262
|
- !ruby/object:Gem::Version
|
235
|
-
version: '1.
|
263
|
+
version: '1.39'
|
236
264
|
type: :development
|
237
265
|
prerelease: false
|
238
266
|
version_requirements: !ruby/object:Gem::Requirement
|
239
267
|
requirements:
|
240
268
|
- - "~>"
|
241
269
|
- !ruby/object:Gem::Version
|
242
|
-
version: '1.
|
270
|
+
version: '1.39'
|
243
271
|
- !ruby/object:Gem::Dependency
|
244
272
|
name: simplecov
|
245
273
|
requirement: !ruby/object:Gem::Requirement
|
246
274
|
requirements:
|
247
275
|
- - "~>"
|
248
276
|
- !ruby/object:Gem::Version
|
249
|
-
version: '0.
|
277
|
+
version: '0.19'
|
250
278
|
type: :development
|
251
279
|
prerelease: false
|
252
280
|
version_requirements: !ruby/object:Gem::Requirement
|
253
281
|
requirements:
|
254
282
|
- - "~>"
|
255
283
|
- !ruby/object:Gem::Version
|
256
|
-
version: '0.
|
257
|
-
description:
|
284
|
+
version: '0.19'
|
285
|
+
description:
|
258
286
|
email:
|
259
287
|
- brooke@alchemists.io
|
260
288
|
executables:
|
261
289
|
- milestoner
|
262
290
|
extensions: []
|
263
291
|
extra_rdoc_files:
|
264
|
-
- README.
|
265
|
-
- LICENSE.
|
292
|
+
- README.adoc
|
293
|
+
- LICENSE.adoc
|
266
294
|
files:
|
267
|
-
- LICENSE.
|
268
|
-
- README.
|
295
|
+
- LICENSE.adoc
|
296
|
+
- README.adoc
|
269
297
|
- bin/milestoner
|
270
298
|
- lib/milestoner.rb
|
271
299
|
- lib/milestoner/cli.rb
|
@@ -278,14 +306,15 @@ files:
|
|
278
306
|
- lib/milestoner/publisher.rb
|
279
307
|
- lib/milestoner/pusher.rb
|
280
308
|
- lib/milestoner/tagger.rb
|
281
|
-
homepage: https://
|
309
|
+
homepage: https://www.alchemists.io/projects/milestoner
|
282
310
|
licenses:
|
283
311
|
- Apache-2.0
|
284
312
|
metadata:
|
285
|
-
source_code_uri: https://github.com/bkuhlmann/milestoner
|
286
|
-
changelog_uri: https://github.com/bkuhlmann/milestoner/blob/master/CHANGES.md
|
287
313
|
bug_tracker_uri: https://github.com/bkuhlmann/milestoner/issues
|
288
|
-
|
314
|
+
changelog_uri: https://www.alchemists.io/projects/milestoner/changes.html
|
315
|
+
documentation_uri: https://www.alchemists.io/projects/milestoner
|
316
|
+
source_code_uri: https://github.com/bkuhlmann/milestoner
|
317
|
+
post_install_message:
|
289
318
|
rdoc_options: []
|
290
319
|
require_paths:
|
291
320
|
- lib
|
@@ -300,8 +329,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
300
329
|
- !ruby/object:Gem::Version
|
301
330
|
version: '0'
|
302
331
|
requirements: []
|
303
|
-
rubygems_version: 3.1.
|
304
|
-
signing_key:
|
332
|
+
rubygems_version: 3.1.4
|
333
|
+
signing_key:
|
305
334
|
specification_version: 4
|
306
335
|
summary: A command line interface for crafting Git repository milestones.
|
307
336
|
test_files: []
|
metadata.gz.sig
CHANGED
Binary file
|
data/README.md
DELETED
@@ -1,204 +0,0 @@
|
|
1
|
-
<p align="center">
|
2
|
-
<img src="milestoner.png" alt="Milestoner Icon"/>
|
3
|
-
</p>
|
4
|
-
|
5
|
-
# Milestoner
|
6
|
-
|
7
|
-
[![Gem Version](https://badge.fury.io/rb/milestoner.svg)](http://badge.fury.io/rb/milestoner)
|
8
|
-
[![Code Climate Maintainability](https://api.codeclimate.com/v1/badges/4cf2547433410a9c7150/maintainability)](https://codeclimate.com/github/bkuhlmann/milestoner/maintainability)
|
9
|
-
[![Code Climate Test Coverage](https://api.codeclimate.com/v1/badges/4cf2547433410a9c7150/test_coverage)](https://codeclimate.com/github/bkuhlmann/milestoner/test_coverage)
|
10
|
-
[![Circle CI Status](https://circleci.com/gh/bkuhlmann/milestoner.svg?style=svg)](https://circleci.com/gh/bkuhlmann/milestoner)
|
11
|
-
|
12
|
-
A command line interface for crafting Git repository milestones (also known as *tags*).
|
13
|
-
|
14
|
-
<!-- Tocer[start]: Auto-generated, don't remove. -->
|
15
|
-
|
16
|
-
## Table of Contents
|
17
|
-
|
18
|
-
- [Features](#features)
|
19
|
-
- [Screencasts](#screencasts)
|
20
|
-
- [Requirements](#requirements)
|
21
|
-
- [Setup](#setup)
|
22
|
-
- [Usage](#usage)
|
23
|
-
- [Command Line Interface (CLI)](#command-line-interface-cli)
|
24
|
-
- [Customization](#customization)
|
25
|
-
- [Security](#security)
|
26
|
-
- [Tests](#tests)
|
27
|
-
- [Versioning](#versioning)
|
28
|
-
- [Code of Conduct](#code-of-conduct)
|
29
|
-
- [Contributions](#contributions)
|
30
|
-
- [License](#license)
|
31
|
-
- [History](#history)
|
32
|
-
- [Credits](#credits)
|
33
|
-
|
34
|
-
<!-- Tocer[finish]: Auto-generated, don't remove. -->
|
35
|
-
|
36
|
-
## Features
|
37
|
-
|
38
|
-
- Uses [Versionaire](https://github.com/bkuhlmann/versionaire) for
|
39
|
-
[Semantic Versioning](https://semver.org).
|
40
|
-
- Format: `<major>.<minor>.<maintenance>`.
|
41
|
-
- Example: `0.1.0`.
|
42
|
-
- Ensures Git commits since last tag (or initialization of repository) are included.
|
43
|
-
- Ensures Git commit messages are grouped by prefix, in order defined. For more details, see [Git
|
44
|
-
Cop Subject Prefix](https://github.com/bkuhlmann/git-cop#commit-subject-prefix) for details.
|
45
|
-
Defaults (can be customized):
|
46
|
-
- Fixed
|
47
|
-
- Added
|
48
|
-
- Updated
|
49
|
-
- Removed
|
50
|
-
- Refactored
|
51
|
-
- Ensures Git commit merge messages are excluded.
|
52
|
-
- Ensures Git commit messages are alphabetically sorted.
|
53
|
-
- Ensures duplicate Git commit messages are removed (if any).
|
54
|
-
- Ensures Git commit messages are sanitized by removing extra spaces and `[ci skip]` text within
|
55
|
-
each Git tag message.
|
56
|
-
- Provides optional security for signing Git tags with [GnuPG](https://www.gnupg.org) signing key.
|
57
|
-
|
58
|
-
## Screencasts
|
59
|
-
|
60
|
-
[![asciicast](https://asciinema.org/a/278645.svg)](https://asciinema.org/a/278645)
|
61
|
-
|
62
|
-
## Requirements
|
63
|
-
|
64
|
-
1. A UNIX-based system.
|
65
|
-
1. [Ruby 2.6.x](https://www.ruby-lang.org).
|
66
|
-
1. [GnuPG](https://www.gnupg.org).
|
67
|
-
|
68
|
-
## Setup
|
69
|
-
|
70
|
-
Type the following to install:
|
71
|
-
|
72
|
-
gem install milestoner
|
73
|
-
|
74
|
-
## Usage
|
75
|
-
|
76
|
-
### Command Line Interface (CLI)
|
77
|
-
|
78
|
-
From the command line, type: `milestoner help`
|
79
|
-
|
80
|
-
milestoner -C, [--commits] # Show commits for next milestone.
|
81
|
-
milestoner -P, [--publish=VERSION] # Tag and push milestone to remote repository.
|
82
|
-
milestoner -c, [--config] # Manage gem configuration.
|
83
|
-
milestoner -h, [--help=COMMAND] # Show this message or get help for a command.
|
84
|
-
milestoner -p, [--push=VERSION] # Push local tag to remote repository.
|
85
|
-
milestoner -t, [--tag=VERSION] # Tag local repository with new version.
|
86
|
-
milestoner -v, [--version] # Show gem version.
|
87
|
-
|
88
|
-
For config options, type: `milestoner help --config`
|
89
|
-
|
90
|
-
-e, [--edit], [--no-edit] # Edit gem configuration.
|
91
|
-
-i, [--info], [--no-info] # Print gem configuration info.
|
92
|
-
|
93
|
-
For tag options, type: `milestoner help --tag`
|
94
|
-
|
95
|
-
-s, [--sign], [--no-sign] # Sign tag with GPG key.
|
96
|
-
|
97
|
-
For publish options, type: `milestoner help --publish`
|
98
|
-
|
99
|
-
-s, [--sign], [--no-sign] # Sign tag with GPG key.
|
100
|
-
|
101
|
-
When using Milestoner, the `--publish` command is intended to be the only command necessary for
|
102
|
-
publishing a new release as it handles all of the steps necessary for tagging and pushing a new
|
103
|
-
milestone. Should individual steps be needed, then the `--tag` and `--push` options are available.
|
104
|
-
|
105
|
-
### Customization
|
106
|
-
|
107
|
-
This gem can be configured via a global configuration:
|
108
|
-
|
109
|
-
~/.config/milestoner/configuration.yml
|
110
|
-
|
111
|
-
|
112
|
-
It can also be configured via [XDG](https://github.com/bkuhlmann/xdg) environment variables.
|
113
|
-
|
114
|
-
The default configuration is as follows:
|
115
|
-
|
116
|
-
:git_commit_prefixes:
|
117
|
-
- Fixed
|
118
|
-
- Added
|
119
|
-
- Updated
|
120
|
-
- Removed
|
121
|
-
- Refactored
|
122
|
-
:git_tag_sign: false
|
123
|
-
|
124
|
-
Feel free to take this default configuration, modify, and save as your own custom
|
125
|
-
`configuration.yml`.
|
126
|
-
|
127
|
-
The `configuration.yml` file can be configured as follows:
|
128
|
-
|
129
|
-
- `git_commit_prefixes`: Should the default prefixes not be desired, you can define Git commit
|
130
|
-
prefixes that match your style. *NOTE: Prefix order is important with the first prefix defined
|
131
|
-
taking precedence over the second and so forth.* Special characters are allowed for prefixes but
|
132
|
-
should be enclosed in quotes. To disable prefix usage completely, use an empty array. Example:
|
133
|
-
`:git_commit_prefixes: []`.
|
134
|
-
- `git_tag_sign`: Defaults to `false` but can be enabled by setting to `true`. When enabled, a Git
|
135
|
-
tag will require GPG signing for enhanced security and include a signed signature as part of the
|
136
|
-
Git tag. This is useful for public milestones where the author of a milestone can be verified to
|
137
|
-
ensure milestone integrity/security.
|
138
|
-
|
139
|
-
## Security
|
140
|
-
|
141
|
-
To securely sign your Git tags, install and configure [GPG](https://www.gnupg.org):
|
142
|
-
|
143
|
-
brew install gpg
|
144
|
-
gpg --gen-key
|
145
|
-
|
146
|
-
When creating your GPG key, choose these settings:
|
147
|
-
|
148
|
-
- Key kind: RSA and RSA (default)
|
149
|
-
- Key size: 4096
|
150
|
-
- Key validity: 0
|
151
|
-
- Real Name: `<your name>`
|
152
|
-
- Email: `<your email>`
|
153
|
-
- Passphrase: `<your passphrase>`
|
154
|
-
|
155
|
-
To obtain your key, run the following and take the part after the forward slash:
|
156
|
-
|
157
|
-
gpg --list-keys | grep pub
|
158
|
-
|
159
|
-
Add your key to your global Git configuration in the `[user]` section. Example:
|
160
|
-
|
161
|
-
[user]
|
162
|
-
signingkey = <your GPG key>
|
163
|
-
|
164
|
-
Now, when publishing a new milestone (i.e. `milestoner --publish <version> --sign`), signing of your
|
165
|
-
Git tag will happen automatically. You will be prompted for the GPG Passphrase each time but that is
|
166
|
-
to be expected.
|
167
|
-
|
168
|
-
## Tests
|
169
|
-
|
170
|
-
To test, run:
|
171
|
-
|
172
|
-
bundle exec spec
|
173
|
-
|
174
|
-
## Versioning
|
175
|
-
|
176
|
-
Read [Semantic Versioning](https://semver.org) for details. Briefly, it means:
|
177
|
-
|
178
|
-
- Major (X.y.z) - Incremented for any backwards incompatible public API changes.
|
179
|
-
- Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
|
180
|
-
- Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.
|
181
|
-
|
182
|
-
## Code of Conduct
|
183
|
-
|
184
|
-
Please note that this project is released with a [CODE OF CONDUCT](CODE_OF_CONDUCT.md). By
|
185
|
-
participating in this project you agree to abide by its terms.
|
186
|
-
|
187
|
-
## Contributions
|
188
|
-
|
189
|
-
Read [CONTRIBUTING](CONTRIBUTING.md) for details.
|
190
|
-
|
191
|
-
## License
|
192
|
-
|
193
|
-
Copyright 2015 [Alchemists](https://www.alchemists.io).
|
194
|
-
Read [LICENSE](LICENSE.md) for details.
|
195
|
-
|
196
|
-
## History
|
197
|
-
|
198
|
-
Read [CHANGES](CHANGES.md) for details.
|
199
|
-
Built with [Gemsmith](https://github.com/bkuhlmann/gemsmith).
|
200
|
-
|
201
|
-
## Credits
|
202
|
-
|
203
|
-
Developed by [Brooke Kuhlmann](https://www.alchemists.io) at
|
204
|
-
[Alchemists](https://www.alchemists.io).
|