Skip to content

Commit

Permalink
Modularize CFF and specify CFF-Core module version 1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
sdruskat committed Dec 11, 2017
1 parent 5e43425 commit a2cab7c
Show file tree
Hide file tree
Showing 13 changed files with 1,288 additions and 2,290 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Expand Up @@ -11,4 +11,5 @@ codekit-config.json
example/_site
Gemfile.lock
node_modules
npm-debug.log*
npm-debug.log*
cff-meta.md
2,279 changes: 0 additions & 2,279 deletions 1.0-SNAPSHOT/specifications.md.draft

This file was deleted.

7 changes: 7 additions & 0 deletions 1.0.0-changes.md
@@ -0,0 +1,7 @@
- [Fix citation-file-format/citation-file-format#20](http://github.com/citation-file-format/citation-file-format.github.io/commit/88966a8721c14ec0933c7751d9883225f9ec861e)
- [Nudge up version to 1.0-RC1](http://github.com/citation-file-format/citation-file-format.github.io/commit/ed121ca45f440c8bee7ee09df1ed485b29978930)
- [Add a section on the status of CFF as compared to transitive credit and free-form files](http://github.com/citation-file-format/citation-file-format.github.io/commit/5d0cf41ab1bc5c255237866dc58371141ccc2e86)
- [Fix citation-file-format/citation-file-format#23: Back-pedal to core specifications for citation-specific use cases](http://github.com/citation-file-format/citation-file-format.github.io/commit/f6c4415dbe4ba0da19c620c9e724201748c677b2)
- [Fix citation-file-format/citation-file-format#25: Use SPDX identifiers for licenses](http://github.com/citation-file-format/citation-file-format.github.io/commit/649b5456b784136aa31777ba208e2df5740474dc)
- [Add changes file for 1.0-RC1](http://github.com/citation-file-format/citation-file-format.github.io/commit/6f81e1d604ee8e2ea68e2459f3d6a155246cd010)
- [Add a note about URL validation via regex](http://github.com/citation-file-format/citation-file-format.github.io/commit/3af8b3947d6fabbaa0fd7da618f3df945dc40441)
9 changes: 9 additions & 0 deletions 1.0.0.md
@@ -0,0 +1,9 @@
---
layout: landing-page
---

This version is the first release of CFF-Core.

## Changes

{% include_relative 1.0.0-changes.md %}
1,251 changes: 1,251 additions & 0 deletions 1.0.0/specifications.md

Large diffs are not rendered by default.

7 changes: 4 additions & 3 deletions README.md
Expand Up @@ -22,14 +22,15 @@ The Markdown dialect is [kramdown](https://kramdown.gettalong.org/), and

Once a version is release-ready, do the following:

- Create a landing page `index.md` file for the version in the `{version}` folder, describing the version (including release notes, changes, etc.).
- 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).
- Commit the changes
- Run changes.sh to create a list of changes to display on the landing page
- Merge the version branch to `src`.
- 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

- Build the PDF files locally by running build-pdfs.py (works with Python 3.6, needs `pypandoc`, `pandoc-frontmatter`, a custom pandoc build from commit [181d737](https://github.com/jgm/pandoc/commit/181d7370bb913a0a9a110b2ae230a079f0c23be1) on the main [Pandoc
repo](https://github.com/jgm/pandoc), `pandoc-citeproc` v >= 0.10.3)
- Build the PDF files locally by running build-pdfs.py (works with Python 3.6, needs `pypandoc`, `pandoc-frontmatter`, Pandoc v >= 2.0.3, `pandoc-citeproc` v >= 0.10.3)
- Push, Travis will take care of the rest
2 changes: 1 addition & 1 deletion _config.yml
Expand Up @@ -10,7 +10,7 @@
#####################################################

# Current CFF version
current : 1.0-RC1
current : "1.0.0"

scholar:
bibtex_filters:
Expand Down
Binary file modified assets/pdf/cff-specifications-0.9-RC1.pdf
Binary file not shown.
Binary file modified assets/pdf/cff-specifications-1.0-RC1.pdf
Binary file not shown.
Binary file added assets/pdf/cff-specifications-1.0.0.pdf
Binary file not shown.
7 changes: 7 additions & 0 deletions build-pdfs.py
Expand Up @@ -82,6 +82,13 @@ def conditional_sub(match):
# Remove Liquid bibliography tag
new_contents = re.sub(r"{% bibliography --cited %}", "", new_contents)

# Replace solid circles with bullets
new_contents = re.sub(r"●", "•", new_contents)

# Replace string "Solid circles ("
new_contents = re.sub(r"Solid circles \(",
"Bullet points (", new_contents)

# Remove Zenodo DOI badge
zdp = """
\[\!\[DOI\]\(https://citation-file-format\.github\.io/assets/
Expand Down
2 changes: 1 addition & 1 deletion 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-RC1 | 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

# Use in Python script for every dir that contains a specifications.md
11 changes: 6 additions & 5 deletions versions.md
Expand Up @@ -3,12 +3,13 @@

# Citation File Format (CFF) - Versions

The existing versions for CFF are listed in the following table.
The existing versions for CFF are listed in the following tables.

- `-RC{n}` builds denote *release candidates* and should not be used for production data.
- `-SNAPSHOT` builds denote *development* releases and should not be used for production data.

|Version|Specifications|Schema|DOI|Release|
|-|-|-|-|-|
|[0.9-RC1](/0.9-RC1/)|[HTML](/0.9-RC1/specifications/) , [PDF](/assets/pdf/cff-specifications-0.9-RC1.pdf)|-|[10.5281/zenodo.1003150](https://doi.org/10.5281/zenodo.1003150.v1)||
|[1.0-RC1](/1.0-RC1/)|[HTML](/1.0-RC1/specifications/) , [PDF](/assets/pdf/cff-specifications-1.0-RC1.pdf)|-|[10.5281/zenodo.1003150](https://doi.org/10.5281/zenodo.1003150)||
| Version | Specifications | Schema | DOI | Release |
|----------------------|--------------------------------------------------------------------------------------|--------|---------------------------------------------------------------------|---------|
| [1.0.0](/1.0.0) | Core module: [HTML](/1.0.0/specifications/), [PDF](/assets/pdf/cff-specifications-1.0.0.pdf) | - | [10.5281/zenodo.1003150](https://doi.org/10.5281/zenodo.1003150) | |
| [1.0-RC1](/1.0-RC1/) | [HTML](/1.0-RC1/specifications/) , [PDF](/assets/pdf/cff-specifications-1.0-RC1.pdf) | - | [10.5281/zenodo.1003150](https://doi.org/10.5281/zenodo.1003150) | |
| [0.9-RC1](/0.9-RC1/) | [HTML](/0.9-RC1/specifications/) , [PDF](/assets/pdf/cff-specifications-0.9-RC1.pdf) | - | [10.5281/zenodo.1003150](https://doi.org/10.5281/zenodo.1003150.v1) | |

0 comments on commit a2cab7c

Please sign in to comment.