Fix #40

Author: sdruskat

.travis.yml

@@ -35,6 +35,6 @@ deploy:
   api_key:
     secure: "BiIpY2KWsO+GDj/+CWcBY9dwmPlYEEwWXqI0uXEKZNNWy4uWjWn625f1x+krTy5RzfH29r1IWub9w0Xf80vtIkqVBEpxGUPYPayHKC1Lal8YIgXCxPTstOKPNuYAWdf2/xoD3tiQrbBt6gAGm/+Pg9knOFRq+T1mYKHZKQTIsSDpZyb7FEG0a67fylJlRY+HGwEdDGc166DLottSMjiwLRbwd7rkYhLTNPeouT7KF7GiAeNXezRwKSylSnkpsibS5J/XWDOuyu+7oW8P11TIaVy22BeMj8SWN9KUQYozqMg+XWjt8zYlZjhB/bF+WiJ21zgw/TTtdnyZJmAuR7xMWj7auRouw4vQuinyTfjn8EmUw2TnOch/1I7yNgAmcF8vTmm2EdueIKEo6BHIH0tb03I1BGDR+bmyfsG9+K5WexsgNuU5UTPss+Jaebq+ZH7u2bVrutYoPGJEHOOCUyO+qgrT/6LlrDO8WBLbmplhh6Wdanf5Z3uvLrqFBngxeAGkLTG5u8BX49rvCgkcKYzUbvL60QNkKQ3OeFOs3JFxj3PJ36hqs6x8j8hRKvBwFpXtUr4QxZUy7QuvDa5zZvbb7QiWZZ6wckiiqhr9LqsdIXm6TzsXKYgTFHjhRyDQIZd9vPzlOrCYVOrc+ocdqvLpXDJFxAtoHNxu8hUemyVzNig="
   file: 
-    - './_site/assets/pdf/cff-specifications-1.0.0.pdf'
+    - './_site/assets/pdf/cff-specifications-1.0.1.pdf'
   on:
     tags: true

0.9-RC1/specifications.md

@@ -15,6 +15,7 @@ abstract:
   <https://github.com/sdruskat/citation-file-format>.
 geometry: margin=2cm
 version: 0.9-RC1
+release-date: 06 October 2017
 ---
 
 {% include toc %}

1.0-RC1/specifications.md

@@ -14,6 +14,7 @@ abstract:
   <https://github.com/citation-file-format/citation-file-format>.
 geometry: margin=2cm
 version: 1.0-RC1
+release-date: 25 October 2017
 ---
 
 {% include toc %}

1.0.0/specifications.md

@@ -15,6 +15,7 @@ abstract:
   format for [CodeMeta](https://codemeta.github.io/) [JSON](https://github.com/codemeta/codemeta/blob/master/codemeta.json) files.
 geometry: margin=2cm
 version: 1.0.0
+release-date: 11 December 2017
 ---
 
 

1.0.1-changes.md

@@ -0,0 +1,2 @@
+- [Fix #39](http://github.com/citation-file-format/citation-file-format.github.io/commit/43c339b7b26bb9c9d87ee804a906945cb7ae8d0b)
+- [Fix #40](http://github.com/citation-file-format/citation-file-format.github.io/commit/bd85415dcbf1c0f3d431dacf2c5607a3505e9741)

1.0.1.md

@@ -0,0 +1,9 @@
+---
+layout: landing-page
+---
+
+This version fixes two bugs.
+
+## Changes
+
+{% include_relative 1.0.1-changes.md %}

1.0.1/specifications.md

@@ -14,7 +14,8 @@ abstract:
   <https://github.com/citation-file-format/citation-file-format>. CFF is a source
   format for [CodeMeta](https://codemeta.github.io/) [JSON](https://github.com/codemeta/codemeta/blob/master/codemeta.json) files.
 geometry: margin=2cm
-version: 1.0.0
+version: 1.0.1
+release-date: 18 December 2017
 ---
 
 
@@ -389,7 +390,7 @@ CFF-Core defines the following reference keys.
   | `repository-artifact`   | String (*URL*)                                                                   | The repository where the (executable/binary) artifact of the work is stored         |
   | `scope`                 | String                                                                           | The scope of the reference, e.g., the section of the work it adheres to             |
   | `section`               | String                                                                           | The section of a work that is referenced                                            |
-  | `senders`               | Collection of *[person objects](#person-objects)*                                | The sender of a personal communication                                              |
+  | `senders`               | Collection of *[entity](#entity-objects)* or *[person objects](#person-objects)* | The sender of a personal communication                                              |
   | `status`                | *[Status string](#status-strings)*                                               | The publication status of the work                                                  |
   | `start`                 | Integer                                                                          | The start page of the work                                                          |
   | `thesis-type`           | String                                                                           | The type of the thesis that is the work                                             |
@@ -429,7 +430,8 @@ references:
 **`authors`**, **`contact`**, **`editors`**, **`editors-series`**, **`recipients`**,
 **`senders`**, **`translators`**
 
-These keys take a collection of [person objects](#person-objects) as value. Person objects
+These keys take a collection of entity objects or 
+[person objects](#person-objects) as value. Person objects
 provide a fixed set of keys to reference individuals, including a detailed
 set for specifiying personal names, an affiliation, etc.
 

README.md

@@ -25,17 +25,26 @@ Specifications are only written in `specifications.md` in a version branch!
 The Markdown dialect is [kramdown](https://kramdown.gettalong.org/), and
 [Jekyll](https://jekyllrb.com/) specificities apply.
 
+Don't forget to change the `version` tag in the YAML metadata at the start of
+`specifications.md`!
+
 Once a version is release-ready, do the following:
 
+- Change the `release-date` meta tag in the YAML frontmatter of `specifications.md`
 - Create a landing page `{version}.md` file for the version in the `{version}` folder, describing the version (including release notes, changes, etc.).
 - In `_config.yml`, set `current` to the version number, e.g., `0.9-RC1`.
 - Add the version to the table in [versions.md](https://github.com/citation-file-format/citation-file-format.github.io/blob/src/versions.md).
+  Create a new version on Zenodo to reserve a DOI, add that DOI to the versions table.
 - Add the version in the PDF link for addition to GitHub release .travis.yml
 - Commit the changes
 - Run changes.sh to create a list of changes to display on the landing page
-- Merge the version branch to `src`.
+- Merge the version branch to `src` and create a version tag.
 - Push `src`. Travis CI will pick up the pushed commit and [build](#build) it. If you don't want your commits to be built automatically, add `[skip ci]` to your commit message.
 
 ### Build
 
-- Push `src` to GitHub, Travis will take care of the rest
+- Push `src` to GitHub, Travis will take care of the rest
+
+### Post-release
+
+- Add the Zenodo DOI badge to the release that has been created by Travis.

_config.yml

@@ -10,7 +10,7 @@
 #####################################################
 
 # Current CFF version
-current                  : "1.0.0"
+current                  : "1.0.1"
 
 scholar:
   bibtex_filters:

changes.sh

@@ -1,5 +1,5 @@
 # git log 1.0-RC1.. --pretty=format:'- [%s](http://github.com/citation-file-format/citation-file-format.github.io/commit/%H)' --reverse | grep -v Merge > changes.md
 # git log src... --pretty=format:'- [%s](http://github.com/citation-file-format/citation-file-format.github.io/commit/%H)' --reverse | grep -v Merge > changes.md
-git log --boundary --no-merges --pretty=format:'- [%s](http://github.com/citation-file-format/citation-file-format.github.io/commit/%H)' --reverse src..1.0.0 | grep -v Merge > 1.0.0-changes.md
+git log --boundary --no-merges --pretty=format:'- [%s](http://github.com/citation-file-format/citation-file-format.github.io/commit/%H)' --reverse src..HEAD | grep -v Merge > 1.X.X-CORRECT-VERSION-HERE-changes.md
 
 # Use in Python script for every dir that contains a specifications.md