milestoner 13.3.0 → 14.0.1
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 +0 -0
- data/LICENSE.adoc +134 -214
- data/README.adoc +33 -35
- data/lib/milestoner/cli/actions/config.rb +5 -7
- data/lib/milestoner/cli/actions/container.rb +22 -0
- data/lib/milestoner/cli/actions/import.rb +11 -0
- data/lib/milestoner/cli/actions/status.rb +5 -5
- data/lib/milestoner/cli/parser.rb +10 -6
- data/lib/milestoner/cli/parsers/core.rb +6 -6
- data/lib/milestoner/cli/shell.rb +8 -25
- data/lib/milestoner/commits/categorizer.rb +6 -6
- data/lib/milestoner/configuration/content.rb +0 -1
- data/lib/milestoner/configuration/defaults.yml +1 -2
- data/lib/milestoner/container.rb +3 -26
- data/lib/milestoner/import.rb +7 -0
- data/lib/milestoner/presenters/commit.rb +6 -4
- data/lib/milestoner/tags/creator.rb +12 -22
- data/lib/milestoner/tags/publisher.rb +6 -6
- data/lib/milestoner/tags/pusher.rb +3 -11
- data/milestoner.gemspec +6 -5
- data.tar.gz.sig +0 -0
- metadata +40 -24
- metadata.gz.sig +0 -0
- data/lib/milestoner/cli/parsers/security.rb +0 -56
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 16e8a7b683f86892598652d74630d0e29375e38957fa8ae8c5991de87625008f
|
4
|
+
data.tar.gz: f5dcd163f1938ca4789da9b8dc85838d0988876a6cdcc568d63ddb4e81cc7d85
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 9ea84b8404efb107caddebd74064498a9070e6ee66d3d277e61c2cabe057f82bf964202d1659e1e97a68fcf9fba63b6b0f28b230892562cfaa1b6ef9d6c915c7
|
7
|
+
data.tar.gz: e98679a24f0b5494be26490ee4ee0b185c8143238490b24646b6d50d48e5072fffb95bd3c4d4bf4e2da31373b4edc9926adb6acf7cc51869db51f5938490234d
|
checksums.yaml.gz.sig
CHANGED
Binary file
|
data/LICENSE.adoc
CHANGED
@@ -1,214 +1,134 @@
|
|
1
|
-
=
|
2
|
-
|
3
|
-
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
52
|
-
|
53
|
-
|
54
|
-
|
55
|
-
|
56
|
-
|
57
|
-
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
|
62
|
-
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
|
67
|
-
|
68
|
-
|
69
|
-
|
70
|
-
|
71
|
-
|
72
|
-
|
73
|
-
|
74
|
-
|
75
|
-
(
|
76
|
-
|
77
|
-
|
78
|
-
|
79
|
-
|
80
|
-
|
81
|
-
|
82
|
-
|
83
|
-
|
84
|
-
|
85
|
-
|
86
|
-
|
87
|
-
|
88
|
-
|
89
|
-
|
90
|
-
|
91
|
-
|
92
|
-
|
93
|
-
|
94
|
-
|
95
|
-
|
96
|
-
|
97
|
-
|
98
|
-
|
99
|
-
|
100
|
-
|
101
|
-
|
102
|
-
|
103
|
-
|
104
|
-
|
105
|
-
|
106
|
-
|
107
|
-
|
108
|
-
|
109
|
-
|
110
|
-
|
111
|
-
|
112
|
-
|
113
|
-
|
114
|
-
|
115
|
-
|
116
|
-
|
117
|
-
|
118
|
-
|
119
|
-
|
120
|
-
|
121
|
-
|
122
|
-
|
123
|
-
|
124
|
-
|
125
|
-
|
126
|
-
|
127
|
-
|
128
|
-
|
129
|
-
|
130
|
-
|
131
|
-
|
132
|
-
|
133
|
-
|
134
|
-
|
135
|
-
|
136
|
-
3.2.1. Only use social auditing mechanisms that adhere to Worker-Driven Social Responsibility Network’s Statement of Principles (https://wsr-network.org/what-is-wsr/statement-of-principles/) over traditional social auditing mechanisms, to the extent the Licensee uses any social auditing mechanisms at all;
|
137
|
-
|
138
|
-
3.2.2. Ensure that if the Licensee has a Board of Directors, 30% of Licensee’s board seats are held by Workers paid no more than 200% of the compensation of the lowest paid Worker of the Licensee;
|
139
|
-
|
140
|
-
3.2.3. Provide clear, accessible supply chain data to the public in accordance with the following conditions:
|
141
|
-
|
142
|
-
3.2.3.1. All data will be on Licensee’s website and/or, to the extent Licensee is a representative, agent, affiliate, successor, attorney, subsidiary, or assign, on Licensee’s principal’s or parent’s website or some other online platform accessible to the public via an internet search on a common internet search engine; and
|
143
|
-
|
144
|
-
3.2.3.2. Data published will include, where applicable, manufacturers, top tier suppliers, subcontractors, cooperatives, component parts producers, and farms;
|
145
|
-
|
146
|
-
3.2.4. Provide equal pay for equal work where the performance of such work requires equal skill, effort, and responsibility, and which are performed under similar working conditions, except where such payment is made pursuant to:
|
147
|
-
|
148
|
-
3.2.4.1. A seniority system;
|
149
|
-
|
150
|
-
3.2.4.2. A merit system;
|
151
|
-
|
152
|
-
3.2.4.3. A system which measures earnings by quantity or quality of production; or
|
153
|
-
|
154
|
-
3.2.4.4. A differential based on any other factor other than sex, gender, sexual orientation, race, ethnicity, nationality, religion, caste, age, medical disability or impairment, and/or any other like circumstances +
|
155
|
-
(See 29 U.S.C.A. § 206(d)(1); Article 23, _United Nations Universal Declaration of Human Rights_; Article 7, _International Covenant on Economic, Social and Cultural Rights_; Article 26, _International Covenant on Civil and Political Rights_); and
|
156
|
-
|
157
|
-
3.2.5. Allow for reasonable limitation of working hours and periodic holidays with pay +
|
158
|
-
(See Article 24, _United Nations Universal Declaration of Human Rights_; Article 7, _International Covenant on Economic, Social and Cultural Rights_).
|
159
|
-
|
160
|
-
== 4. SUPPLY CHAIN IMPACTED PARTIES
|
161
|
-
|
162
|
-
_This section identifies additional individuals or entities that a Licensee could harm as a result of violating the Ethical Standards section, the condition that the Licensee must voluntarily accept a Duty of Care for those individuals or entities, and the right to a private right of action that those individuals or entities possess as a result of violations of the Ethical Standards section._
|
163
|
-
|
164
|
-
4.1. In addition to the above Ethical Standards, Licensee voluntarily accepts a Duty of Care for Supply Chain Impacted Parties of this License, including individuals and communities impacted by violations of the Ethical Standards. The Duty of Care is breached when a provision within the Ethical Standards section is violated by a Licensee, one of its successors or assigns, or by an individual or entity that exists within the Supply Chain prior to a good or service reaching the Licensee.
|
165
|
-
|
166
|
-
4.2. Breaches of the Duty of Care, as stated within this section, shall create a private right of action, allowing any Supply Chain Impacted Party harmed by the Licensee to take legal action against the Licensee in accordance with applicable negligence laws, whether they be in tort law, delict law, and/or similar bodies of law closely related to tort and/or delict law, regardless if Licensee is directly responsible for the harms suffered by a Supply Chain Impacted Party. Nothing in this section shall be interpreted to include acts committed by individuals outside of the scope of his/her/their employment.
|
167
|
-
|
168
|
-
== 5. NOTICE
|
169
|
-
|
170
|
-
_This section explains when a Licensee must notify others of the License._
|
171
|
-
|
172
|
-
5.1. _Distribution of Notice_: Licensee must ensure that everyone who receives a copy of or uses any part of Software from Licensee, with or without changes, also receives the License and the copyright notice included with Software (and if included by the Licensor, patent, trademark, and attribution notice). Licensee must ensure that License is prominently displayed so that any individual or entity seeking to download, copy, use, or otherwise receive any part of Software from Licensee is notified of this License and its terms and conditions. Licensee must cause any modified versions of the Software to carry prominent notices stating that Licensee changed the Software.
|
173
|
-
|
174
|
-
5.2. _Modified Software_: Licensee is free to create modifications of the Software and distribute only the modified portion created by Licensee, however, any derivative work stemming from the Software or its code must be distributed pursuant to this License, including this Notice provision.
|
175
|
-
|
176
|
-
5.3. _Recipients as Licensees_: Any individual or entity that uses, copies, modifies, reproduces, distributes, or prepares derivative work based upon the Software, all or part of the Software’s code, or a derivative work developed by using the Software, including a portion of its code, is a Licensee as defined above and is subject to the terms and conditions of this License.
|
177
|
-
|
178
|
-
== 6. REPRESENTATIONS AND WARRANTIES
|
179
|
-
|
180
|
-
6.1. _Disclaimer of Warranty_: TO THE FULL EXTENT ALLOWED BY LAW, THIS SOFTWARE COMES "AS IS," WITHOUT ANY WARRANTY, EXPRESS OR IMPLIED, AND LICENSOR SHALL NOT BE LIABLE TO ANY PERSON OR ENTITY FOR ANY DAMAGES OR OTHER LIABILITY ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THIS LICENSE, UNDER ANY LEGAL CLAIM.
|
181
|
-
|
182
|
-
6.2. _Limitation of Liability_: LICENSEE SHALL HOLD LICENSOR HARMLESS AGAINST ANY AND ALL CLAIMS, DEBTS, DUES, LIABILITIES, LIENS, CAUSES OF ACTION, DEMANDS, OBLIGATIONS, DISPUTES, DAMAGES, LOSSES, EXPENSES, ATTORNEYS’ FEES, COSTS, LIABILITIES, AND ALL OTHER CLAIMS OF EVERY KIND AND NATURE WHATSOEVER, WHETHER KNOWN OR UNKNOWN, ANTICIPATED OR UNANTICIPATED, FORESEEN OR UNFORESEEN, ACCRUED OR UNACCRUED, DISCLOSED OR UNDISCLOSED, ARISING OUT OF OR RELATING TO LICENSEE’S USE OF THE SOFTWARE. NOTHING IN THIS SECTION SHOULD BE INTERPRETED TO REQUIRE LICENSEE TO INDEMNIFY LICENSOR, NOR REQUIRE LICENSOR TO INDEMNIFY LICENSEE.
|
183
|
-
|
184
|
-
== 7. TERMINATION
|
185
|
-
|
186
|
-
7.1. _Violations of Ethical Standards or Breaching Duty of Care_: If Licensee violates the Ethical Standards section or Licensee, or any other person or entity within the Supply Chain prior to a good or service reaching the Licensee, breaches its Duty of Care to Supply Chain Impacted Parties, Licensee must remedy the violation or harm caused by Licensee within 30 days of being notified of the violation or harm. If Licensee fails to remedy the violation or harm within 30 days, all rights in the Software granted to Licensee by License will be null and void as between Licensor and Licensee.
|
187
|
-
|
188
|
-
7.2. _Failure of Notice_: If any person or entity notifies Licensee in writing that Licensee has not complied with the Notice section of this License, Licensee can keep this License by taking all practical steps to comply within 30 days after the notice of noncompliance. If Licensee does not do so, Licensee’s License (and all rights licensed hereunder) will end immediately.
|
189
|
-
|
190
|
-
7.3. _Judicial Findings_: In the event Licensee is found by a civil, criminal, administrative, or other court of competent jurisdiction, or some other adjudicating body with legal authority, to have committed actions which are in violation of the Ethical Standards or Supply Chain Impacted Party sections of this License, all rights granted to Licensee by this License will terminate immediately.
|
191
|
-
|
192
|
-
7.4. _Patent Litigation_: If Licensee institutes patent litigation against any entity (including a cross-claim or counterclaim in a suit) alleging that the Software, all or part of the Software’s code, or a derivative work developed using the Software, including a portion of its code, constitutes direct or contributory patent infringement, then any patent license, along with all other rights, granted to Licensee under this License will terminate as of the date such litigation is filed.
|
193
|
-
|
194
|
-
7.5. _Additional Remedies_: Termination of the License by failing to remedy harms in no way prevents Licensor or Supply Chain Impacted Party from seeking appropriate remedies at law or in equity.
|
195
|
-
|
196
|
-
== 8. MISCELLANEOUS
|
197
|
-
|
198
|
-
8.1. _Conditions_: Sections 3, 4.1, 5.1, 5.2, 7.1, 7.2, 7.3, and 7.4 are conditions of the rights granted to Licensee in the License.
|
199
|
-
|
200
|
-
8.2. _Equitable Relief_: Licensor and any Supply Chain Impacted Party shall be entitled to equitable relief, including injunctive relief or specific performance of the terms hereof, in addition to any other remedy to which they are entitled at law or in equity.
|
201
|
-
|
202
|
-
8.3. _Copyleft_: Modified software, source code, or other derivative work must be licensed, in its entirety, under the exact same conditions as this License.
|
203
|
-
|
204
|
-
8.4. _Severability_: If any term or provision of this License is determined to be invalid, illegal, or unenforceable by a court of competent jurisdiction, any such determination of invalidity, illegality, or unenforceability shall not affect any other term or provision of this License or invalidate or render unenforceable such term or provision in any other jurisdiction. If the determination of invalidity, illegality, or unenforceability by a court of competent jurisdiction pertains to the terms or provisions contained in the Ethical Standards section of this License, all rights in the Software granted to Licensee shall be deemed null and void as between Licensor and Licensee.
|
205
|
-
|
206
|
-
8.5. _Section Titles_: Section titles are solely written for organizational purposes and should not be used to interpret the language within each section.
|
207
|
-
|
208
|
-
8.6. _Citations_: Citations are solely written to provide context for the source of the provisions in the Ethical Standards.
|
209
|
-
|
210
|
-
8.7. _Section Summaries_: Some sections have a brief _italicized description_ which is provided for the sole purpose of briefly describing the section and should not be used to interpret the terms of the License.
|
211
|
-
|
212
|
-
8.8. _Entire License_: This is the entire License between the Licensor and Licensee with respect to the claims released herein and that the consideration stated herein is the only consideration or compensation to be paid or exchanged between them for this License. This License cannot be modified or amended except in a writing signed by Licensor and Licensee.
|
213
|
-
|
214
|
-
8.9. _Successors and Assigns_: This License shall be binding upon and inure to the benefit of the Licensor’s and Licensee’s respective heirs, successors, and assigns.
|
1
|
+
= Hippocratic License
|
2
|
+
|
3
|
+
Version: 2.1.0.
|
4
|
+
|
5
|
+
Purpose. The purpose of this License is for the Licensor named above to
|
6
|
+
permit the Licensee (as defined below) broad permission, if consistent
|
7
|
+
with Human Rights Laws and Human Rights Principles (as each is defined
|
8
|
+
below), to use and work with the Software (as defined below) within the
|
9
|
+
full scope of Licensor’s copyright and patent rights, if any, in the
|
10
|
+
Software, while ensuring attribution and protecting the Licensor from
|
11
|
+
liability.
|
12
|
+
|
13
|
+
Permission and Conditions. The Licensor grants permission by this
|
14
|
+
license ("License"), free of charge, to the extent of Licensor’s
|
15
|
+
rights under applicable copyright and patent law, to any person or
|
16
|
+
entity (the "Licensee") obtaining a copy of this software and
|
17
|
+
associated documentation files (the "Software"), to do everything with
|
18
|
+
the Software that would otherwise infringe (i) the Licensor’s copyright
|
19
|
+
in the Software or (ii) any patent claims to the Software that the
|
20
|
+
Licensor can license or becomes able to license, subject to all of the
|
21
|
+
following terms and conditions:
|
22
|
+
|
23
|
+
* Acceptance. This License is automatically offered to every person and
|
24
|
+
entity subject to its terms and conditions. Licensee accepts this
|
25
|
+
License and agrees to its terms and conditions by taking any action with
|
26
|
+
the Software that, absent this License, would infringe any intellectual
|
27
|
+
property right held by Licensor.
|
28
|
+
* Notice. Licensee must ensure that everyone who gets a copy of any part
|
29
|
+
of this Software from Licensee, with or without changes, also receives
|
30
|
+
the License and the above copyright notice (and if included by the
|
31
|
+
Licensor, patent, trademark and attribution notice). Licensee must cause
|
32
|
+
any modified versions of the Software to carry prominent notices stating
|
33
|
+
that Licensee changed the Software. For clarity, although Licensee is
|
34
|
+
free to create modifications of the Software and distribute only the
|
35
|
+
modified portion created by Licensee with additional or different terms,
|
36
|
+
the portion of the Software not modified must be distributed pursuant to
|
37
|
+
this License. If anyone notifies Licensee in writing that Licensee has
|
38
|
+
not complied with this Notice section, Licensee can keep this License by
|
39
|
+
taking all practical steps to comply within 30 days after the notice. If
|
40
|
+
Licensee does not do so, Licensee’s License (and all rights licensed
|
41
|
+
hereunder) shall end immediately.
|
42
|
+
* Compliance with Human Rights Principles and Human Rights Laws.
|
43
|
+
[arabic]
|
44
|
+
. Human Rights Principles.
|
45
|
+
[loweralpha]
|
46
|
+
.. Licensee is advised to consult the articles of the United Nations
|
47
|
+
Universal Declaration of Human Rights and the United Nations Global
|
48
|
+
Compact that define recognized principles of international human rights
|
49
|
+
(the "Human Rights Principles"). Licensee shall use the Software in a
|
50
|
+
manner consistent with Human Rights Principles.
|
51
|
+
.. Unless the Licensor and Licensee agree otherwise, any dispute,
|
52
|
+
controversy, or claim arising out of or relating to (i) Section 1(a)
|
53
|
+
regarding Human Rights Principles, including the breach of Section 1(a),
|
54
|
+
termination of this License for breach of the Human Rights Principles,
|
55
|
+
or invalidity of Section 1(a) or (ii) a determination of whether any Law
|
56
|
+
is consistent or in conflict with Human Rights Principles pursuant to
|
57
|
+
Section 2, below, shall be settled by arbitration in accordance with the
|
58
|
+
Hague Rules on Business and Human Rights Arbitration (the "Rules");
|
59
|
+
provided, however, that Licensee may elect not to participate in such
|
60
|
+
arbitration, in which event this License (and all rights licensed
|
61
|
+
hereunder) shall end immediately. The number of arbitrators shall be one
|
62
|
+
unless the Rules require otherwise.
|
63
|
+
+
|
64
|
+
Unless both the Licensor and Licensee agree to the contrary: (1) All
|
65
|
+
documents and information concerning the arbitration shall be public and
|
66
|
+
may be disclosed by any party; (2) The repository referred to under
|
67
|
+
Article 43 of the Rules shall make available to the public in a timely
|
68
|
+
manner all documents concerning the arbitration which are communicated
|
69
|
+
to it, including all submissions of the parties, all evidence admitted
|
70
|
+
into the record of the proceedings, all transcripts or other recordings
|
71
|
+
of hearings and all orders, decisions and awards of the arbitral
|
72
|
+
tribunal, subject only to the arbitral tribunal’s powers to take such
|
73
|
+
measures as may be necessary to safeguard the integrity of the arbitral
|
74
|
+
process pursuant to Articles 18, 33, 41 and 42 of the Rules; and (3)
|
75
|
+
Article 26(6) of the Rules shall not apply.
|
76
|
+
. Human Rights Laws. The Software shall not be used by any person or
|
77
|
+
entity for any systems, activities, or other uses that violate any Human
|
78
|
+
Rights Laws. "Human Rights Laws" means any applicable laws,
|
79
|
+
regulations, or rules (collectively, "Laws") that protect human,
|
80
|
+
civil, labor, privacy, political, environmental, security, economic, due
|
81
|
+
process, or similar rights; provided, however, that such Laws are
|
82
|
+
consistent and not in conflict with Human Rights Principles (a dispute
|
83
|
+
over the consistency or a conflict between Laws and Human Rights
|
84
|
+
Principles shall be determined by arbitration as stated above). Where
|
85
|
+
the Human Rights Laws of more than one jurisdiction are applicable or in
|
86
|
+
conflict with respect to the use of the Software, the Human Rights Laws
|
87
|
+
that are most protective of the individuals or groups harmed shall
|
88
|
+
apply.
|
89
|
+
. Indemnity. Licensee shall hold harmless and indemnify Licensor (and
|
90
|
+
any other contributor) against all losses, damages, liabilities,
|
91
|
+
deficiencies, claims, actions, judgments, settlements, interest, awards,
|
92
|
+
penalties, fines, costs, or expenses of whatever kind, including
|
93
|
+
Licensor’s reasonable attorneys’ fees, arising out of or relating to
|
94
|
+
Licensee’s use of the Software in violation of Human Rights Laws or
|
95
|
+
Human Rights Principles.
|
96
|
+
* Failure to Comply. Any failure of Licensee to act according to the
|
97
|
+
terms and conditions of this License is both a breach of the License and
|
98
|
+
an infringement of the intellectual property rights of the Licensor
|
99
|
+
(subject to exceptions under Laws, e.g., fair use). In the event of a
|
100
|
+
breach or infringement, the terms and conditions of this License may be
|
101
|
+
enforced by Licensor under the Laws of any jurisdiction to which
|
102
|
+
Licensee is subject. Licensee also agrees that the Licensor may enforce
|
103
|
+
the terms and conditions of this License against Licensee through
|
104
|
+
specific performance (or similar remedy under Laws) to the extent
|
105
|
+
permitted by Laws. For clarity, except in the event of a breach of this
|
106
|
+
License, infringement, or as otherwise stated in this License, Licensor
|
107
|
+
may not terminate this License with Licensee.
|
108
|
+
* Enforceability and Interpretation. If any term or provision of this
|
109
|
+
License is determined to be invalid, illegal, or unenforceable by a
|
110
|
+
court of competent jurisdiction, then such invalidity, illegality, or
|
111
|
+
unenforceability shall not affect any other term or provision of this
|
112
|
+
License or invalidate or render unenforceable such term or provision in
|
113
|
+
any other jurisdiction; provided, however, subject to a court
|
114
|
+
modification pursuant to the immediately following sentence, if any term
|
115
|
+
or provision of this License pertaining to Human Rights Laws or Human
|
116
|
+
Rights Principles is deemed invalid, illegal, or unenforceable against
|
117
|
+
Licensee by a court of competent jurisdiction, all rights in the
|
118
|
+
Software granted to Licensee shall be deemed null and void as between
|
119
|
+
Licensor and Licensee. Upon a determination that any term or provision
|
120
|
+
is invalid, illegal, or unenforceable, to the extent permitted by Laws,
|
121
|
+
the court may modify this License to affect the original purpose that
|
122
|
+
the Software be used in compliance with Human Rights Principles and
|
123
|
+
Human Rights Laws as closely as possible. The language in this License
|
124
|
+
shall be interpreted as to its fair meaning and not strictly for or
|
125
|
+
against any party.
|
126
|
+
* Disclaimer. TO THE FULL EXTENT ALLOWED BY LAW, THIS SOFTWARE COMES
|
127
|
+
"AS IS," WITHOUT ANY WARRANTY, EXPRESS OR IMPLIED, AND LICENSOR AND
|
128
|
+
ANY OTHER CONTRIBUTOR SHALL NOT BE LIABLE TO ANYONE FOR ANY DAMAGES OR
|
129
|
+
OTHER LIABILITY ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE
|
130
|
+
OR THIS LICENSE, UNDER ANY KIND OF LEGAL CLAIM.
|
131
|
+
|
132
|
+
This Hippocratic License is an link:https://ethicalsource.dev[Ethical Source license] and is offered
|
133
|
+
for use by licensors and licensees at their own risk, on an "AS IS" basis, and with no warranties
|
134
|
+
express or implied, to the maximum extent permitted by Laws.
|
data/README.adoc
CHANGED
@@ -4,13 +4,18 @@
|
|
4
4
|
|
5
5
|
= Milestoner
|
6
6
|
|
7
|
-
Milestoner is a command line interface for crafting Git repository tags (milestones) using
|
8
|
-
versions. Each milestone is a summary of all commits made since
|
9
|
-
Milestoner to inspect what is currently
|
10
|
-
having a tool, like Milestoner, you can
|
11
|
-
reliable fashion. Milestoner
|
12
|
-
|
13
|
-
|
7
|
+
Milestoner is a command line interface for crafting Git repository tags (milestones) using
|
8
|
+
link:https://semver.org[semantic versions]. Each milestone is a summary of all commits made since
|
9
|
+
the last milestone. You can use Milestoner to inspect what is currently pending or create a new
|
10
|
+
release via a single command. By having a tool, like Milestoner, you can automate releases in a
|
11
|
+
consistent and reliable fashion. Milestoner pairs well with the following gems:
|
12
|
+
|
13
|
+
- link:https://www.alchemists.io/projects/git-lint[Git Lint] - Ensures your commit messages are of
|
14
|
+
high quality which feed into the release notes built by Milestoner.
|
15
|
+
- link:https://www.alchemists.io/projects/rubysmith[Rubysmith] - Use Milestoner to automate the
|
16
|
+
publishing of new or existing Ruby project versions.
|
17
|
+
- link:https://www.alchemists.io/projects/gemsmith[Gemsmith] - Is built on top of Milestoner and is
|
18
|
+
used to publish new Ruby gem versions.
|
14
19
|
|
15
20
|
toc::[]
|
16
21
|
|
@@ -31,13 +36,12 @@ toc::[]
|
|
31
36
|
** Refactored
|
32
37
|
* Ensures Git commit messages are alphabetically sorted.
|
33
38
|
* Ensures duplicate Git commit messages are removed (if any).
|
34
|
-
* Provides optional security for signing Git tags with https://www.gnupg.org[GnuPG] signing key.
|
35
39
|
|
36
40
|
== Requirements
|
37
41
|
|
38
42
|
. A UNIX-based system.
|
39
43
|
. https://www.ruby-lang.org[Ruby].
|
40
|
-
. https://www.gnupg.org[GnuPG].
|
44
|
+
. https://www.gnupg.org[GnuPG] (optional).
|
41
45
|
|
42
46
|
== Setup
|
43
47
|
|
@@ -61,9 +65,6 @@ USAGE:
|
|
61
65
|
-P, --publish VERSION Tag and push milestone to remote repository.
|
62
66
|
-s, --status Show project status.
|
63
67
|
-v, --version Show gem version.
|
64
|
-
|
65
|
-
SECURITY OPTIONS:
|
66
|
-
--[no-]sign Sign with GPG key. Default: false.
|
67
68
|
....
|
68
69
|
|
69
70
|
Examples:
|
@@ -72,13 +73,8 @@ Examples:
|
|
72
73
|
----
|
73
74
|
milestoner --config edit
|
74
75
|
milestoner --config view
|
75
|
-
|
76
76
|
milestoner --help
|
77
|
-
|
78
77
|
milestoner --publish 0.1.0
|
79
|
-
milestoner --publish 0.1.0 --sign
|
80
|
-
milestoner --publish 0.1.0 --no-sign
|
81
|
-
|
82
78
|
milestoner --status
|
83
79
|
milestoner --version
|
84
80
|
----
|
@@ -98,14 +94,13 @@ The default configuration is as follows:
|
|
98
94
|
[source,yaml]
|
99
95
|
----
|
100
96
|
:documentation:
|
101
|
-
:format: "
|
97
|
+
:format: "adoc"
|
102
98
|
:prefixes:
|
103
99
|
- Fixed
|
104
100
|
- Added
|
105
101
|
- Updated
|
106
102
|
- Removed
|
107
103
|
- Refactored
|
108
|
-
:sign: false
|
109
104
|
----
|
110
105
|
|
111
106
|
Feel free to take this default configuration, modify, and save as your own custom
|
@@ -113,18 +108,16 @@ Feel free to take this default configuration, modify, and save as your own custo
|
|
113
108
|
|
114
109
|
The `+configuration.yml+` file can be configured as follows:
|
115
110
|
|
116
|
-
* *
|
117
|
-
|
118
|
-
|
119
|
-
|
120
|
-
|
121
|
-
|
122
|
-
|
123
|
-
|
124
|
-
|
125
|
-
|
126
|
-
the Git tag. This is useful for public milestones where the author of a milestone can be verified
|
127
|
-
to ensure milestone integrity/security.
|
111
|
+
* *Documentation Format* (i.e. `documentation`): Determines what format the release notes should be
|
112
|
+
rendered as. This effects both status information from the command line and the release notes
|
113
|
+
embedded within the body of a Git tag. Defaults to
|
114
|
+
link:https://asciidoctor.org/docs/what-is-asciidoc[ASCII Doc] (i.e. `adoc`) but
|
115
|
+
link:https://daringfireball.net/projects/markdown[Markdown] (i.e. `md`) is supported too.
|
116
|
+
* *Git Commit Prefixes* (i.e. `prefixes`): Should the default prefixes not be desired, you can
|
117
|
+
define Git commit prefixes that match your style. _NOTE: Prefix order is important with the first
|
118
|
+
prefix defined taking precedence over the second and so forth._ Special characters are allowed for
|
119
|
+
prefixes but should be enclosed in quotes. To disable prefix usage completely, use an empty array.
|
120
|
+
Example: `:prefixes: []`.
|
128
121
|
|
129
122
|
== Security
|
130
123
|
|
@@ -151,16 +144,21 @@ To obtain your key, run the following and take the part after the forward slash:
|
|
151
144
|
gpg --list-keys | grep pub
|
152
145
|
....
|
153
146
|
|
154
|
-
Add your key to your global Git configuration
|
147
|
+
Add your key to your global (or local) Git configuration and ensure GPG signing for your tag is
|
148
|
+
enabled. Example:
|
155
149
|
|
156
150
|
....
|
151
|
+
[tag]
|
152
|
+
gpgSign = true
|
157
153
|
[user]
|
158
154
|
signingkey = <your GPG key>
|
159
155
|
....
|
160
156
|
|
161
|
-
Now, when publishing a new milestone (i.e.
|
162
|
-
|
163
|
-
|
157
|
+
Now, when publishing a new milestone (i.e. `milestoner --publish <version>`), the signing of your
|
158
|
+
Git tag will happen automatically. You will be prompted for the GPG Passphrase each time unless you
|
159
|
+
are running the
|
160
|
+
link:https://gnupg.org/documentation/manuals/gnupg/Invoking-GPG_002dAGENT.html#Invoking-GPG_002dAGENT[GPG
|
161
|
+
Agent] in the background (highly recommend).
|
164
162
|
|
165
163
|
== Development
|
166
164
|
|
@@ -5,9 +5,11 @@ module Milestoner
|
|
5
5
|
module Actions
|
6
6
|
# Handles the gem configuration action.
|
7
7
|
class Config
|
8
|
-
|
8
|
+
include Milestoner::Import[:kernel, :logger]
|
9
|
+
|
10
|
+
def initialize configuration: Configuration::Loader::CLIENT, **dependencies
|
11
|
+
super(**dependencies)
|
9
12
|
@configuration = configuration
|
10
|
-
@container = container
|
11
13
|
end
|
12
14
|
|
13
15
|
def call action
|
@@ -20,15 +22,11 @@ module Milestoner
|
|
20
22
|
|
21
23
|
private
|
22
24
|
|
23
|
-
attr_reader :configuration
|
25
|
+
attr_reader :configuration
|
24
26
|
|
25
27
|
def edit = kernel.system("$EDITOR #{configuration.current}")
|
26
28
|
|
27
29
|
def view = kernel.system("cat #{configuration.current}")
|
28
|
-
|
29
|
-
def kernel = container[__method__]
|
30
|
-
|
31
|
-
def logger = container[__method__]
|
32
30
|
end
|
33
31
|
end
|
34
32
|
end
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require "dry/container"
|
4
|
+
|
5
|
+
module Milestoner
|
6
|
+
module CLI
|
7
|
+
module Actions
|
8
|
+
# Provides a single container with application and action specific dependencies.
|
9
|
+
module Container
|
10
|
+
extend Dry::Container::Mixin
|
11
|
+
|
12
|
+
config.registry = ->(container, key, value, _options) { container[key.to_s] = value }
|
13
|
+
|
14
|
+
merge Milestoner::Container
|
15
|
+
|
16
|
+
register(:config) { Config.new }
|
17
|
+
register(:publish) { Publish.new }
|
18
|
+
register(:status) { Status.new }
|
19
|
+
end
|
20
|
+
end
|
21
|
+
end
|
22
|
+
end
|