Skip to content

Commit 6ad535c

Browse files
committed
Add a CHANGES file.
1 parent ccf2d90 commit 6ad535c

File tree

2 files changed

+90
-1
lines changed

2 files changed

+90
-1
lines changed

CHANGES.md

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# Changes log for the Ruby CFF Library
2+
3+
## Version 0.2.0
4+
5+
* Add a rubygems version badge to the README.
6+
* Add older rubies to the CI, but allow failures.
7+
* Add the licence to the gemspec.
8+
* Rename the ALLOWED_METHODS list to FIELDS.
9+
* Send missing methods straight to Model, from File.
10+
* Fix passing through arguments for missing methods (File).
11+
* Add a Util module with delete_from_hash as first utility.
12+
* Move method_to_field to the Util module.
13+
* Refactor for more complete parsing ability.
14+
* Freeze the allowed fields constant in Model.
15+
* Change allowed fields to be more flexible
16+
* Add abstract to Model.
17+
* Factor out the process of converting array fields to yaml.
18+
* Fix test for authors that was split incorrectly.
19+
* Add contact to Model.
20+
* Add tests to check capitalized fields are rejected.
21+
* Refactor model building for maintainability.
22+
* Add commit to the Model.
23+
* Add doi to the Model.
24+
* Add keywords to Model.
25+
* Fix #11: prevent serialization of empty collections.
26+
* Add license to Model.
27+
* Refactor testing simple fields.
28+
* Add license-url to Model.
29+
* Simplify parsing the keywords in Model.
30+
* Refactor testing reading complete CFF file.
31+
* Add repository* to Model.
32+
* Add url to Model.
33+
* Fix #12: typo in README example usage.
34+
* Add to the quick start example in the README.
35+
* Create a new base class (ModelPart) for parts of the model.
36+
* Add ModelPart#method_missing.
37+
* Add affiliation to Person, and tests for it too.
38+
* Add address to Entity, and tests for it too.
39+
* Add accessors for required fields on Person, Entity.
40+
* Add the rest of the optional fields in Person.
41+
* Add the rest of the simple fields in Entity.
42+
* Add the date fields in Entity.
43+
* Test dates in Entity with text inputs.
44+
45+
## Version 0.1.0
46+
47+
* Add a code of conduct.
48+
* Add Travis configuration.
49+
* Add licence text to all source files.
50+
* Add a Travis badge to the README.
51+
* Add a CodeClimate badge to the README.
52+
* Set up coveralls integration.
53+
* Add a coveralls badge to the README.
54+
* Add the current CFF spec version as the default.
55+
* Add a simple model class.
56+
* Message doesn't need to be passed to new.
57+
* Add title to model and wire into default message.
58+
* Add a method to set the message.
59+
* Remove the default values on ingestion.
60+
* Swap requires in main cff file.
61+
* Only set a default message on construction.
62+
* Add a File class to read and write CFF files.
63+
* Switch to using standard accessor for message field.
64+
* Streamline title output tests.
65+
* Add a set title method to Model and test it.
66+
* Turn off line wrapping in Model yaml output.
67+
* Fix #2. Don't include title in the default message.
68+
* Test that yaml output doesn't include the header.
69+
* Write cff from a String or Model.
70+
* Fix #3. Create a File from either a model or title.
71+
* When testing file loading, compare to yaml directly.
72+
* Test the message is loaded correctly into a File.
73+
* Add version to the Model and File APIs.
74+
* Add date-released to the Model and File APIs.
75+
* Fix cff_version test.
76+
* Move the Model class to a Hash-based implementation.
77+
* Initialize Model with a title or a Hash.
78+
* Update the File class to use the new Model class.
79+
* Use a method whitelist for Model and File.
80+
* Add a Person model to represent authors.
81+
* Add an Entity model to represent authors.
82+
83+
## About this file
84+
85+
This file is, at least in part, generated by the following command:
86+
87+
```shell
88+
$ git log --pretty=format:"* %s" --reverse --no-merges <commit-hash>..
89+
```

Rakefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ end
2626

2727
RDoc::Task.new do |r|
2828
r.main = "README.md"
29-
r.rdoc_files.include("README.md", "LICENCE", "lib/**/*.rb")
29+
r.rdoc_files.include("README.md", "LICENCE", "CHANGES.md", "lib/**/*.rb")
3030
r.options << "--markup=markdown"
3131
r.options << "--tab-width=2"
3232
r.options << "-t Ruby CFF Library version #{::CFF::VERSION}"

0 commit comments

Comments
 (0)