parse_a_changelog 0.2.3 → 1.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/CHANGELOG.md +39 -2
- data/LICENSE +202 -0
- data/README.md +28 -7
- data/VERSION +1 -1
- data/bin/parse +7 -0
- data/lib/grammar.tt +46 -18
- data/lib/parse_a_changelog.rb +8 -6
- metadata +32 -5
- data/LICENSE.md +0 -163
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: dc6ea631789752275f5afc1bb3e94e3752827eb2753b8b9805ef3a836519266c
|
4
|
+
data.tar.gz: 3c68137deda564cac32e076068f53e524df8b8c0de945acab05854dc6aef9446
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 3d5df26f7560aa96d37b61ca99fc46fad02f536d2ecab9e24a43e835d6296bb9df084f999232df862af26cf108e87c5cfa31d68d926c7c2e732e01036eee3050
|
7
|
+
data.tar.gz: 50024c9454ba8abb7b0c72693d4638ffa5b9e85707826873b25ed6e1d384c1e2d4d23b324a1e567298a16ad195adac7edbcbf911c1e0ca322c5e7ef3837ad3d0
|
data/CHANGELOG.md
CHANGED
@@ -6,6 +6,37 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
|
|
6
6
|
|
7
7
|
## [Unreleased]
|
8
8
|
|
9
|
+
## [1.2.0] - 2021-06-20
|
10
|
+
### Changed
|
11
|
+
- Allow CHANGELOG without SemVer declaration.
|
12
|
+
[cyberark/parse-a-changelog#37](https://github.com/cyberark/parse-a-changelog/issues/37)
|
13
|
+
|
14
|
+
## [1.1.0] - 2020-11-12
|
15
|
+
### Added
|
16
|
+
- Allow for metadata section in version string.
|
17
|
+
[cyberark/parse-a-changelog#34](https://github.com/cyberark/parse-a-changelog/issues/34)
|
18
|
+
|
19
|
+
## [1.0.2] - 2020-08-26
|
20
|
+
### Fixed
|
21
|
+
- Added support for semver pre-releases.
|
22
|
+
[cyberark/parse-a-changelog#29](https://github.com/cyberark/parse-a-changelog/issues/29).
|
23
|
+
|
24
|
+
## [1.0.1] - 2020-03-06
|
25
|
+
### Added
|
26
|
+
- Jenkins pipeline with ruby gems publication
|
27
|
+
- Test and Publish scripts
|
28
|
+
|
29
|
+
### Changed
|
30
|
+
- Allow https in header links
|
31
|
+
|
32
|
+
### Removed
|
33
|
+
- Gitlab CI support
|
34
|
+
|
35
|
+
## [1.0.0] - 2019-01-30
|
36
|
+
### Added
|
37
|
+
- Missing (optional) initial release tag link as last entry in links section to the grammar
|
38
|
+
- Release instructions
|
39
|
+
|
9
40
|
## [0.2.3] - 2019-01-30
|
10
41
|
### Fixed
|
11
42
|
- Include tt extension when requiring grammar
|
@@ -40,16 +71,22 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
|
|
40
71
|
### Removed
|
41
72
|
- Fixed incorrect Ruby file name in binary
|
42
73
|
|
43
|
-
## 0.1.0 - 2019-01-23
|
74
|
+
## [0.1.0] - 2019-01-23
|
44
75
|
### Added
|
45
76
|
- First draft of the Keep A Changelog parser
|
46
77
|
- Open source license and contributing information
|
47
78
|
- Change log and versioning information
|
48
79
|
|
49
|
-
[Unreleased]: https://github.com/cyberark/parse-a-changelog/compare/
|
80
|
+
[Unreleased]: https://github.com/cyberark/parse-a-changelog/compare/v1.2.0...HEAD
|
81
|
+
[1.2.0]: https://github.com/cyberark/parse-a-changelog/compare/v1.1.0...v1.2.0
|
82
|
+
[1.1.0]: https://github.com/cyberark/parse-a-changelog/compare/v1.0.2...v1.1.0
|
83
|
+
[1.0.2]: https://github.com/cyberark/parse-a-changelog/compare/v1.0.1...v1.0.2
|
84
|
+
[1.0.1]: https://github.com/cyberark/parse-a-changelog/compare/v1.0.0...v1.0.1
|
85
|
+
[1.0.0]: https://github.com/cyberark/parse-a-changelog/compare/v0.2.3...v1.0.0
|
50
86
|
[0.2.3]: https://github.com/cyberark/parse-a-changelog/compare/v0.2.2...v0.2.3
|
51
87
|
[0.2.2]: https://github.com/cyberark/parse-a-changelog/compare/v0.2.1...v0.2.2
|
52
88
|
[0.2.1]: https://github.com/cyberark/parse-a-changelog/compare/v0.2.0...v0.2.1
|
53
89
|
[0.2.0]: https://github.com/cyberark/parse-a-changelog/compare/v0.1.2...v0.2.0
|
54
90
|
[0.1.2]: https://github.com/cyberark/parse-a-changelog/compare/v0.1.1...v0.1.2
|
55
91
|
[0.1.1]: https://github.com/cyberark/parse-a-changelog/compare/v0.1.0...v0.1.1
|
92
|
+
[0.1.0]: https://github.com/cyberark/parse-a-changelog/releases/tag/v0.1.0
|
data/LICENSE
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright (c) 2020 CyberArk Software Ltd. All rights reserved.
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/README.md
CHANGED
@@ -1,29 +1,38 @@
|
|
1
1
|
# parse-a-changelog
|
2
2
|
|
3
|
-
This gem
|
4
|
-
|
5
|
-
It does so by defining the Keep a Changelog grammar and using the [treetop parsing DSL](https://github.com/cjheath/treetop) to parse your changelog file according to that grammar.
|
3
|
+
This gem can be used to validate that a file conforms to the [Keep a Changelog](https://keepachangelog.com) standard. It does this by defining a Keep a Changelog [grammar](https://github.com/cyberark/parse-a-changelog/blob/master/lib/grammar.tt) and using the [treetop parsing DSL](https://github.com/cjheath/treetop) to parse a changelog file according to that grammar.
|
6
4
|
|
7
5
|
## Usage
|
8
6
|
|
9
|
-
Add `parse-a-changelog` to your Gemfile and `bundle install` or install directly with:
|
7
|
+
Add `parse-a-changelog` to your `Gemfile` and `bundle install` or install it directly with:
|
10
8
|
|
11
9
|
```
|
12
10
|
gem install parse-a-changelog
|
13
11
|
```
|
14
12
|
|
15
|
-
The gem can
|
13
|
+
The gem includes a binary that can be run with the changelog file as its single argument:
|
16
14
|
|
17
15
|
```
|
18
16
|
parse path/to/changelog
|
19
17
|
```
|
20
18
|
|
21
|
-
Or
|
19
|
+
Or you can use the gem directly in your Ruby code:
|
22
20
|
|
23
21
|
```
|
24
22
|
result = ParseAChangelog::parse("path/to/changelog")
|
25
23
|
```
|
26
24
|
|
25
|
+
Finally, here is an example bash script that runs `parse-a-changelog` on the current directory in a Docker container, which can be useful for including changelog validation in a CI pipeline:
|
26
|
+
|
27
|
+
```
|
28
|
+
#!/bin/bash -ex
|
29
|
+
|
30
|
+
docker run \
|
31
|
+
--rm \
|
32
|
+
--volume "${PWD}/CHANGELOG.md":/CHANGELOG.md \
|
33
|
+
cyberark/parse-a-changelog
|
34
|
+
```
|
35
|
+
|
27
36
|
# Development
|
28
37
|
|
29
38
|
We welcome contributions of all kinds to `parse-a-changelog`. See our [contributing guide](CONTRIBUTING.md).
|
@@ -40,6 +49,18 @@ Finished in 0.02494 seconds (files took 0.21634 seconds to load)
|
|
40
49
|
18 examples, 0 failures
|
41
50
|
```
|
42
51
|
|
52
|
+
# Releasing
|
53
|
+
|
54
|
+
1. Create a branch
|
55
|
+
1. Determine the appropriate version using [semver](https://semver.org/) and update the `VERSION` file.
|
56
|
+
1. Move the contents of the Unreleased section in `CHANGELOG.md` into a new section using the current release version and date.
|
57
|
+
1. Update the links at the bottom of `CHANGELOG.md`.
|
58
|
+
1. Commit these changes with a commit message about bumping the version.
|
59
|
+
1. Run `git tag <release-version> && git push origin --tags`
|
60
|
+
1. Create a PR to have the release approved and merged.
|
61
|
+
1. Build the gem: `gem build parse_a_changelog.gemspec`
|
62
|
+
1. Push the gem: `gem push parse_a_changelog-<release-version>.gem` (this may require [setting up publishing credentials](https://guides.rubygems.org/publishing/))
|
63
|
+
|
43
64
|
# License
|
44
65
|
|
45
|
-
The parse-a-changelog gem is licensed under Apache License 2.0 - see [`LICENSE
|
66
|
+
The parse-a-changelog gem is licensed under Apache License 2.0 - see [`LICENSE`](LICENSE) for more details.
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
|
1
|
+
1.2.0
|
data/bin/parse
CHANGED
data/lib/grammar.tt
CHANGED
@@ -4,20 +4,28 @@ grammar KeepAChangelog
|
|
4
4
|
end
|
5
5
|
|
6
6
|
rule changelog_header
|
7
|
-
'# Changelog'
|
8
|
-
'All notable changes to this project will be documented in this file.'
|
9
|
-
|
10
|
-
'
|
11
|
-
|
12
|
-
|
7
|
+
'# Changelog' new_line
|
8
|
+
'All notable changes to this project will be documented in this file.' new_line
|
9
|
+
new_line
|
10
|
+
keep_a_changelog_format '.'? new_line
|
11
|
+
(semver_convention new_line)?
|
12
|
+
new_line
|
13
|
+
end
|
14
|
+
|
15
|
+
rule keep_a_changelog_format
|
16
|
+
'The format is based on [Keep a Changelog](http' 's'? '://keepachangelog.com/en/1.0.0/)'
|
17
|
+
end
|
18
|
+
|
19
|
+
rule semver_convention
|
20
|
+
'and this project adheres to [Semantic Versioning](http' 's'? '://semver.org/spec/v2.0.0.html).'
|
13
21
|
end
|
14
22
|
|
15
23
|
rule unreleased_section
|
16
|
-
unreleased_header change_section? (
|
24
|
+
unreleased_header change_section? (new_line change_section)*
|
17
25
|
end
|
18
26
|
|
19
27
|
rule unreleased_header
|
20
|
-
'## ' '['? 'Unreleased' ']'?
|
28
|
+
'## ' '['? 'Unreleased' ']'? new_line
|
21
29
|
end
|
22
30
|
|
23
31
|
rule change_section
|
@@ -25,27 +33,39 @@ grammar KeepAChangelog
|
|
25
33
|
end
|
26
34
|
|
27
35
|
rule change_header
|
28
|
-
'### ' ('Added' / 'Changed' / 'Deprecated' / 'Removed' / 'Fixed' / 'Security')
|
36
|
+
'### ' ('Added' / 'Changed' / 'Deprecated' / 'Removed' / 'Fixed' / 'Security') new_line
|
29
37
|
end
|
30
38
|
|
31
39
|
rule change
|
32
|
-
('- ' / ' ') (!
|
40
|
+
('- ' / ' ') (!new_line .)+ new_line?
|
33
41
|
end
|
34
42
|
|
35
43
|
rule releases_section
|
36
44
|
release*
|
37
45
|
end
|
38
|
-
|
46
|
+
|
39
47
|
rule release
|
40
|
-
|
48
|
+
new_line release_header change_section? (new_line change_section)*
|
41
49
|
end
|
42
50
|
|
43
51
|
rule release_header
|
44
|
-
'## ' '['? release_version ']'? ' - ' release_date
|
52
|
+
'## ' '['? release_version ']'? ' - ' release_date new_line
|
45
53
|
end
|
46
54
|
|
47
55
|
rule release_version
|
48
|
-
[0-9]+ '.' [0-9]+ '.' [0-9]+
|
56
|
+
[0-9]+ '.' [0-9]+ '.' [0-9]+ pre_release_version metadata
|
57
|
+
end
|
58
|
+
|
59
|
+
rule pre_release_version
|
60
|
+
( '-' [0-9A-Za-z-]+ dot_separated_group* ) / ''
|
61
|
+
end
|
62
|
+
|
63
|
+
rule metadata
|
64
|
+
( '+' [0-9A-Za-z-]+ dot_separated_group* ) / ''
|
65
|
+
end
|
66
|
+
|
67
|
+
rule dot_separated_group
|
68
|
+
'.' [0-9A-Za-z-]+
|
49
69
|
end
|
50
70
|
|
51
71
|
rule release_date
|
@@ -53,15 +73,19 @@ grammar KeepAChangelog
|
|
53
73
|
end
|
54
74
|
|
55
75
|
rule diff_section
|
56
|
-
|
76
|
+
new_line unreleased_diff release_diff* initial_release?
|
57
77
|
end
|
58
78
|
|
59
79
|
rule unreleased_diff
|
60
|
-
'[Unreleased]: ' release_url
|
80
|
+
'[Unreleased]: ' release_url new_line
|
81
|
+
end
|
82
|
+
|
83
|
+
rule initial_release
|
84
|
+
'[' release_version ']: ' 'https://github.com/' (!'/' .)+ '/' (!'/' .)+ '/releases/tag/v' release_version new_line
|
61
85
|
end
|
62
86
|
|
63
87
|
rule release_diff
|
64
|
-
'[' release_version ']: ' release_url
|
88
|
+
'[' release_version ']: ' release_url new_line
|
65
89
|
end
|
66
90
|
|
67
91
|
rule release_url
|
@@ -69,6 +93,10 @@ grammar KeepAChangelog
|
|
69
93
|
end
|
70
94
|
|
71
95
|
rule diff_version
|
72
|
-
|
96
|
+
'HEAD' / ( 'v' release_version )
|
97
|
+
end
|
98
|
+
|
99
|
+
rule new_line
|
100
|
+
"\n"
|
73
101
|
end
|
74
102
|
end
|
data/lib/parse_a_changelog.rb
CHANGED
@@ -1,5 +1,5 @@
|
|
1
1
|
require 'treetop'
|
2
|
-
require 'grammar
|
2
|
+
require 'grammar'
|
3
3
|
|
4
4
|
module ParseAChangelog
|
5
5
|
class ParseError < StandardError; end
|
@@ -10,15 +10,17 @@ module ParseAChangelog
|
|
10
10
|
parser = KeepAChangelogParser.new
|
11
11
|
result = parser.parse(file)
|
12
12
|
|
13
|
-
|
14
|
-
raise
|
13
|
+
unless result
|
14
|
+
raise parser_error(
|
15
|
+
parser.failure_line, parser.failure_column, parser.failure_reason
|
16
|
+
)
|
15
17
|
end
|
16
|
-
|
18
|
+
|
17
19
|
result
|
18
20
|
end
|
19
21
|
|
20
|
-
def
|
21
|
-
|
22
|
+
def parser_error(line, column, reason)
|
23
|
+
ParseError.new("line #{line}, column #{column}: #{reason}")
|
22
24
|
end
|
23
25
|
end
|
24
26
|
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: parse_a_changelog
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version:
|
4
|
+
version: 1.2.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- John Tuttle
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2021-06-20 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: treetop
|
@@ -38,6 +38,34 @@ dependencies:
|
|
38
38
|
- - "~>"
|
39
39
|
- !ruby/object:Gem::Version
|
40
40
|
version: '3.8'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rspec_junit_formatter
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: 0.4.1
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: 0.4.1
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: pry-byebug
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: 3.9.0
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: 3.9.0
|
41
69
|
description: Uses a grammar describing the keep-a-changelog format to attempt to parse
|
42
70
|
a given file.
|
43
71
|
email: jtuttle.develops@gmail.com
|
@@ -47,7 +75,7 @@ extensions: []
|
|
47
75
|
extra_rdoc_files: []
|
48
76
|
files:
|
49
77
|
- CHANGELOG.md
|
50
|
-
- LICENSE
|
78
|
+
- LICENSE
|
51
79
|
- README.md
|
52
80
|
- VERSION
|
53
81
|
- bin/parse
|
@@ -72,8 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
72
100
|
- !ruby/object:Gem::Version
|
73
101
|
version: '0'
|
74
102
|
requirements: []
|
75
|
-
|
76
|
-
rubygems_version: 2.6.12
|
103
|
+
rubygems_version: 3.1.6
|
77
104
|
signing_key:
|
78
105
|
specification_version: 4
|
79
106
|
summary: A validator for the keep-a-changelog format
|
data/LICENSE.md
DELETED
@@ -1,163 +0,0 @@
|
|
1
|
-
GNU Lesser General Public License
|
2
|
-
=================================
|
3
|
-
|
4
|
-
_Version 3, 29 June 2007_
|
5
|
-
_Copyright © 2007 Free Software Foundation, Inc. <<http://fsf.org/>>_
|
6
|
-
|
7
|
-
Everyone is permitted to copy and distribute verbatim copies
|
8
|
-
of this license document, but changing it is not allowed.
|
9
|
-
|
10
|
-
|
11
|
-
This version of the GNU Lesser General Public License incorporates
|
12
|
-
the terms and conditions of version 3 of the GNU General Public
|
13
|
-
License, supplemented by the additional permissions listed below.
|
14
|
-
|
15
|
-
### 0. Additional Definitions
|
16
|
-
|
17
|
-
As used herein, “this License” refers to version 3 of the GNU Lesser
|
18
|
-
General Public License, and the “GNU GPL” refers to version 3 of the GNU
|
19
|
-
General Public License.
|
20
|
-
|
21
|
-
“The Library” refers to a covered work governed by this License,
|
22
|
-
other than an Application or a Combined Work as defined below.
|
23
|
-
|
24
|
-
An “Application” is any work that makes use of an interface provided
|
25
|
-
by the Library, but which is not otherwise based on the Library.
|
26
|
-
Defining a subclass of a class defined by the Library is deemed a mode
|
27
|
-
of using an interface provided by the Library.
|
28
|
-
|
29
|
-
A “Combined Work” is a work produced by combining or linking an
|
30
|
-
Application with the Library. The particular version of the Library
|
31
|
-
with which the Combined Work was made is also called the “Linked
|
32
|
-
Version”.
|
33
|
-
|
34
|
-
The “Minimal Corresponding Source” for a Combined Work means the
|
35
|
-
Corresponding Source for the Combined Work, excluding any source code
|
36
|
-
for portions of the Combined Work that, considered in isolation, are
|
37
|
-
based on the Application, and not on the Linked Version.
|
38
|
-
|
39
|
-
The “Corresponding Application Code” for a Combined Work means the
|
40
|
-
object code and/or source code for the Application, including any data
|
41
|
-
and utility programs needed for reproducing the Combined Work from the
|
42
|
-
Application, but excluding the System Libraries of the Combined Work.
|
43
|
-
|
44
|
-
### 1. Exception to Section 3 of the GNU GPL
|
45
|
-
|
46
|
-
You may convey a covered work under sections 3 and 4 of this License
|
47
|
-
without being bound by section 3 of the GNU GPL.
|
48
|
-
|
49
|
-
### 2. Conveying Modified Versions
|
50
|
-
|
51
|
-
If you modify a copy of the Library, and, in your modifications, a
|
52
|
-
facility refers to a function or data to be supplied by an Application
|
53
|
-
that uses the facility (other than as an argument passed when the
|
54
|
-
facility is invoked), then you may convey a copy of the modified
|
55
|
-
version:
|
56
|
-
|
57
|
-
* **a)** under this License, provided that you make a good faith effort to
|
58
|
-
ensure that, in the event an Application does not supply the
|
59
|
-
function or data, the facility still operates, and performs
|
60
|
-
whatever part of its purpose remains meaningful, or
|
61
|
-
|
62
|
-
* **b)** under the GNU GPL, with none of the additional permissions of
|
63
|
-
this License applicable to that copy.
|
64
|
-
|
65
|
-
### 3. Object Code Incorporating Material from Library Header Files
|
66
|
-
|
67
|
-
The object code form of an Application may incorporate material from
|
68
|
-
a header file that is part of the Library. You may convey such object
|
69
|
-
code under terms of your choice, provided that, if the incorporated
|
70
|
-
material is not limited to numerical parameters, data structure
|
71
|
-
layouts and accessors, or small macros, inline functions and templates
|
72
|
-
(ten or fewer lines in length), you do both of the following:
|
73
|
-
|
74
|
-
* **a)** Give prominent notice with each copy of the object code that the
|
75
|
-
Library is used in it and that the Library and its use are
|
76
|
-
covered by this License.
|
77
|
-
* **b)** Accompany the object code with a copy of the GNU GPL and this license
|
78
|
-
document.
|
79
|
-
|
80
|
-
### 4. Combined Works
|
81
|
-
|
82
|
-
You may convey a Combined Work under terms of your choice that,
|
83
|
-
taken together, effectively do not restrict modification of the
|
84
|
-
portions of the Library contained in the Combined Work and reverse
|
85
|
-
engineering for debugging such modifications, if you also do each of
|
86
|
-
the following:
|
87
|
-
|
88
|
-
* **a)** Give prominent notice with each copy of the Combined Work that
|
89
|
-
the Library is used in it and that the Library and its use are
|
90
|
-
covered by this License.
|
91
|
-
|
92
|
-
* **b)** Accompany the Combined Work with a copy of the GNU GPL and this license
|
93
|
-
document.
|
94
|
-
|
95
|
-
* **c)** For a Combined Work that displays copyright notices during
|
96
|
-
execution, include the copyright notice for the Library among
|
97
|
-
these notices, as well as a reference directing the user to the
|
98
|
-
copies of the GNU GPL and this license document.
|
99
|
-
|
100
|
-
* **d)** Do one of the following:
|
101
|
-
- **0)** Convey the Minimal Corresponding Source under the terms of this
|
102
|
-
License, and the Corresponding Application Code in a form
|
103
|
-
suitable for, and under terms that permit, the user to
|
104
|
-
recombine or relink the Application with a modified version of
|
105
|
-
the Linked Version to produce a modified Combined Work, in the
|
106
|
-
manner specified by section 6 of the GNU GPL for conveying
|
107
|
-
Corresponding Source.
|
108
|
-
- **1)** Use a suitable shared library mechanism for linking with the
|
109
|
-
Library. A suitable mechanism is one that **(a)** uses at run time
|
110
|
-
a copy of the Library already present on the user's computer
|
111
|
-
system, and **(b)** will operate properly with a modified version
|
112
|
-
of the Library that is interface-compatible with the Linked
|
113
|
-
Version.
|
114
|
-
|
115
|
-
* **e)** Provide Installation Information, but only if you would otherwise
|
116
|
-
be required to provide such information under section 6 of the
|
117
|
-
GNU GPL, and only to the extent that such information is
|
118
|
-
necessary to install and execute a modified version of the
|
119
|
-
Combined Work produced by recombining or relinking the
|
120
|
-
Application with a modified version of the Linked Version. (If
|
121
|
-
you use option **4d0**, the Installation Information must accompany
|
122
|
-
the Minimal Corresponding Source and Corresponding Application
|
123
|
-
Code. If you use option **4d1**, you must provide the Installation
|
124
|
-
Information in the manner specified by section 6 of the GNU GPL
|
125
|
-
for conveying Corresponding Source.)
|
126
|
-
|
127
|
-
### 5. Combined Libraries
|
128
|
-
|
129
|
-
You may place library facilities that are a work based on the
|
130
|
-
Library side by side in a single library together with other library
|
131
|
-
facilities that are not Applications and are not covered by this
|
132
|
-
License, and convey such a combined library under terms of your
|
133
|
-
choice, if you do both of the following:
|
134
|
-
|
135
|
-
* **a)** Accompany the combined library with a copy of the same work based
|
136
|
-
on the Library, uncombined with any other library facilities,
|
137
|
-
conveyed under the terms of this License.
|
138
|
-
* **b)** Give prominent notice with the combined library that part of it
|
139
|
-
is a work based on the Library, and explaining where to find the
|
140
|
-
accompanying uncombined form of the same work.
|
141
|
-
|
142
|
-
### 6. Revised Versions of the GNU Lesser General Public License
|
143
|
-
|
144
|
-
The Free Software Foundation may publish revised and/or new versions
|
145
|
-
of the GNU Lesser General Public License from time to time. Such new
|
146
|
-
versions will be similar in spirit to the present version, but may
|
147
|
-
differ in detail to address new problems or concerns.
|
148
|
-
|
149
|
-
Each version is given a distinguishing version number. If the
|
150
|
-
Library as you received it specifies that a certain numbered version
|
151
|
-
of the GNU Lesser General Public License “or any later version”
|
152
|
-
applies to it, you have the option of following the terms and
|
153
|
-
conditions either of that published version or of any later version
|
154
|
-
published by the Free Software Foundation. If the Library as you
|
155
|
-
received it does not specify a version number of the GNU Lesser
|
156
|
-
General Public License, you may choose any version of the GNU Lesser
|
157
|
-
General Public License ever published by the Free Software Foundation.
|
158
|
-
|
159
|
-
If the Library as you received it specifies that a proxy can decide
|
160
|
-
whether future versions of the GNU Lesser General Public License shall
|
161
|
-
apply, that proxy's public statement of acceptance of any version is
|
162
|
-
permanent authorization for you to choose that version for the
|
163
|
-
Library.
|