Skip to content

Commit

Permalink
Update project metadata files ready for release.
Browse files Browse the repository at this point in the history
  • Loading branch information
hainesr committed Aug 18, 2021
1 parent 30ed623 commit 394b8c3
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 10 deletions.
18 changes: 18 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,23 @@
# Changes log for the Ruby CFF Library

## Version 0.9.0

* Update to final released version of schema 1.2.0.
* Add `description` field to `Identifier`.
* Add `Model::read` to parse a CFF file from memory.
* Add `Model::open`. Same as `read` but can take a block.
* Override `File#to_yaml`.
* Allow `File::write` to write File objects.
* Add `save_as` parameter to `File#write`.
* Add `Reference::from_cff`.
* Update CITATION.cff file to reference CFF repo.
* Fix `File` docs to be explicit about filenames.
* Validate the filename of a CFF file.
* Surface the `fail_fast` options on the `File` validatation methods.
* Reduce json_schema dependency to ~0.20.0.
* Fix APA-like formatter when a reference is missing a volume.
* APA: don't emit journal data if there's no journal.

## Version 0.8.0

* Add a comment field to the File class.
Expand Down
15 changes: 9 additions & 6 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# This CITATION.cff file was created by ruby-cff (v 0.8.0).
# This CITATION.cff file was created by ruby-cff (v 0.9.0).
# Gem: https://rubygems.org/gems/cff
# CFF: https://citation-file-format.github.io/

Expand All @@ -15,12 +15,15 @@ authors:
keywords:
- ruby
- credit
- citation
- software citation
- research software
- software sustainability
- metadata
- cff
version: 0.8.0
- citation file format
- CFF
version: 0.9.0
doi: 10.5281/zenodo.1184077
date-released: 2021-08-08
date-released: 2021-08-18
license: Apache-2.0
repository-artifact: https://rubygems.org/gems/cff
repository-code: https://github.com/citation-file-format/ruby-cff
Expand Down Expand Up @@ -77,4 +80,4 @@ references:
abstract: CITATION.cff files are plain text files with human- and machine-readable citation information for software. Code developers can include them in their repositories to let others know how to correctly cite their software. This is the specification for the Citation File Format.
date-released: 2021-08-09
license: CC-BY-4.0
version: 1.2.0
version: 1.2.0
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ keywords:
- ruby
- credit
- citation
version: 0.8.0
date-released: 2021-08-08
version: 0.9.0
date-released: 2021-08-18
license: Apache-2.0
repository-artifact: https://rubygems.org/gems/cff
repository-code: https://github.com/citation-file-format/ruby-cff
Expand Down Expand Up @@ -167,7 +167,7 @@ year = {2021}
#### APA-like format

```
Haines, R. (2021). Ruby CFF Library (Version 0.8.0) [Computer software]. https://github.com/citation-file-format/ruby-cff
Haines, R. (2021). Ruby CFF Library (Version 0.9.0) [Computer software]. https://github.com/citation-file-format/ruby-cff
```
#### Citing a paper rather than software
Expand Down
2 changes: 1 addition & 1 deletion lib/cff/version.rb
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
##
module CFF
# :nodoc:
VERSION = '0.8.0'
VERSION = '0.9.0'
DEFAULT_SPEC_VERSION = '1.2.0'
MIN_VALIDATABLE_VERSION = '1.2.0'
end

0 comments on commit 394b8c3

Please sign in to comment.