Skip to content

Commit 1ba5459

Browse files
committed
Finish 1.0.1
2 parents 2fbe6fb + 9475d50 commit 1ba5459

12 files changed

Lines changed: 1285 additions & 8 deletions

File tree

.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,6 @@ deploy:
3535
api_key:
3636
secure: "BiIpY2KWsO+GDj/+CWcBY9dwmPlYEEwWXqI0uXEKZNNWy4uWjWn625f1x+krTy5RzfH29r1IWub9w0Xf80vtIkqVBEpxGUPYPayHKC1Lal8YIgXCxPTstOKPNuYAWdf2/xoD3tiQrbBt6gAGm/+Pg9knOFRq+T1mYKHZKQTIsSDpZyb7FEG0a67fylJlRY+HGwEdDGc166DLottSMjiwLRbwd7rkYhLTNPeouT7KF7GiAeNXezRwKSylSnkpsibS5J/XWDOuyu+7oW8P11TIaVy22BeMj8SWN9KUQYozqMg+XWjt8zYlZjhB/bF+WiJ21zgw/TTtdnyZJmAuR7xMWj7auRouw4vQuinyTfjn8EmUw2TnOch/1I7yNgAmcF8vTmm2EdueIKEo6BHIH0tb03I1BGDR+bmyfsG9+K5WexsgNuU5UTPss+Jaebq+ZH7u2bVrutYoPGJEHOOCUyO+qgrT/6LlrDO8WBLbmplhh6Wdanf5Z3uvLrqFBngxeAGkLTG5u8BX49rvCgkcKYzUbvL60QNkKQ3OeFOs3JFxj3PJ36hqs6x8j8hRKvBwFpXtUr4QxZUy7QuvDa5zZvbb7QiWZZ6wckiiqhr9LqsdIXm6TzsXKYgTFHjhRyDQIZd9vPzlOrCYVOrc+ocdqvLpXDJFxAtoHNxu8hUemyVzNig="
3737
file:
38-
- './_site/assets/pdf/cff-specifications-1.0.0.pdf'
38+
- './_site/assets/pdf/cff-specifications-1.0.1.pdf'
3939
on:
4040
tags: true

0.9-RC1/specifications.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ abstract:
1515
<https://github.com/sdruskat/citation-file-format>.
1616
geometry: margin=2cm
1717
version: 0.9-RC1
18+
release-date: 06 October 2017
1819
---
1920

2021
{% include toc %}

1.0-RC1/specifications.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ abstract:
1414
<https://github.com/citation-file-format/citation-file-format>.
1515
geometry: margin=2cm
1616
version: 1.0-RC1
17+
release-date: 25 October 2017
1718
---
1819

1920
{% include toc %}

1.0.0/specifications.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ abstract:
1515
format for [CodeMeta](https://codemeta.github.io/) [JSON](https://github.com/codemeta/codemeta/blob/master/codemeta.json) files.
1616
geometry: margin=2cm
1717
version: 1.0.0
18+
release-date: 11 December 2017
1819
---
1920

2021

1.0.1-changes.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
- [Fix #39](http://github.com/citation-file-format/citation-file-format.github.io/commit/43c339b7b26bb9c9d87ee804a906945cb7ae8d0b)
2+
- [Fix #40](http://github.com/citation-file-format/citation-file-format.github.io/commit/bd85415dcbf1c0f3d431dacf2c5607a3505e9741)

1.0.1.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
layout: landing-page
3+
---
4+
5+
This version fixes two bugs.
6+
7+
## Changes
8+
9+
{% include_relative 1.0.1-changes.md %}

1.0.1/specifications.md

Lines changed: 1253 additions & 0 deletions
Large diffs are not rendered by default.

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,17 +25,26 @@ Specifications are only written in `specifications.md` in a version branch!
2525
The Markdown dialect is [kramdown](https://kramdown.gettalong.org/), and
2626
[Jekyll](https://jekyllrb.com/) specificities apply.
2727

28+
Don't forget to change the `version` tag in the YAML metadata at the start of
29+
`specifications.md`!
30+
2831
Once a version is release-ready, do the following:
2932

33+
- Change the `release-date` meta tag in the YAML frontmatter of `specifications.md`
3034
- Create a landing page `{version}.md` file for the version in the `{version}` folder, describing the version (including release notes, changes, etc.).
3135
- In `_config.yml`, set `current` to the version number, e.g., `0.9-RC1`.
3236
- Add the version to the table in [versions.md](https://github.com/citation-file-format/citation-file-format.github.io/blob/src/versions.md).
37+
Create a new version on Zenodo to reserve a DOI, add that DOI to the versions table.
3338
- Add the version in the PDF link for addition to GitHub release .travis.yml
3439
- Commit the changes
3540
- Run changes.sh to create a list of changes to display on the landing page
36-
- Merge the version branch to `src`.
41+
- Merge the version branch to `src` and create a version tag.
3742
- 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.
3843

3944
### Build
4045

41-
- Push `src` to GitHub, Travis will take care of the rest
46+
- Push `src` to GitHub, Travis will take care of the rest
47+
48+
### Post-release
49+
50+
- Add the Zenodo DOI badge to the release that has been created by Travis.

_config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
#####################################################
1111

1212
# Current CFF version
13-
current : "1.0.0"
13+
current : "1.0.1"
1414

1515
scholar:
1616
bibtex_filters:

changes.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# 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
22
# 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
3-
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
3+
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
44

55
# Use in Python script for every dir that contains a specifications.md

0 commit comments

Comments
 (0)