Skip to content

Commit

Permalink
Merge pull request #53 from DILCISBoard/rel/2.0
Browse files Browse the repository at this point in the history
Release v2.0.4
  • Loading branch information
karinbredenberg authored Jun 16, 2020
2 parents 1e2619b + 674eeeb commit 1e5841d
Show file tree
Hide file tree
Showing 26 changed files with 1,437 additions and 173 deletions.
16 changes: 16 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Site publication file
docs/
site/
Gemfile.lock
**/_site

.classpath
.project
.settings
**/*.jar
**/target
**/bin
**/*.class
.vagrant*
.venv
vendor
27 changes: 8 additions & 19 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,40 +3,29 @@ sudo: required
language: java
jdk:
- openjdk8
- oraclejdk8
before_install:
- sudo apt-get update
- sudo apt-get install -y texlive texlive-base texlive-latex-extra texlive-fonts-extra
python-virtualenv librsvg2-bin
- wget https://github.com/jgm/pandoc/releases/download/2.5/pandoc-2.5-linux.tar.gz
- tar -xzvf pandoc-2.5-linux.tar.gz
- rm pandoc-2.5-linux.tar.gz
- sudo mv pandoc-2.5 /opt
- sudo chmod +x /opt/pandoc-2.5/bin/pandoc
- sudo ln -s /opt/pandoc-2.5/bin/pandoc /usr/local/bin/pandoc
- sudo ln -s /opt/pandoc-2.5/bin/pandoc-citeproc /usr/local/bin/pandoc-citeproc
script:
- cd spec-publisher
- mvn clean package
- java -jar target/mets-profile-proc.jar ../profile/E-ARK-DIP.xml
- cd ..
- bash create-site.sh
- bundle install
- bundle exec jekyll build -s ./docs -d ./_site
- bundle exec htmlproofer ./_site --file-ignore /javadoc/ --only-4xx --check-html
- docker run -it --rm -v "$PWD:/source" -u "$(id -u):$(id -g)" --entrypoint /source/create-site.sh eark4all/spec-pdf-publisher
- cd spec-publisher
- git checkout feat/pdf-publication
- mvn clean package
- java -jar target/mets-profile-proc.jar ../profile/E-ARK-DIP.xml
- cd ..
- bash create-pdf.sh
- docker run -it --rm -v "$PWD:/source" -u "$(id -u):$(id -g)" --entrypoint /source/create-pdf.sh eark4all/spec-pdf-publisher
- mkdir site
- docker run -it --rm -v "$PWD"/docs:/usr/src/app -v "$PWD"/site:/_site -u "$(id -u):$(id -g)" starefossen/github-pages jekyll build -d /_site
- bundle install
- bundle exec htmlproofer ./site --file-ignore /javadoc/ --only-4xx --check-html
deploy:
provider: pages
skip_cleanup: true
github_token: "$GH_TOKEN"
keep_history: true
local_dir: docs
fqdn: earkdip.dilcis.eu
local_dir: site
fqdn: "$CNAME"
on:
branch: master
env:
Expand Down
1 change: 0 additions & 1 deletion Gemfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
source 'https://rubygems.org'
gem 'github-pages', group: :jekyll_plugins
gem "jekyll-theme-primer", group: :jekyll_plugin
gem 'html-proofer'
61 changes: 61 additions & 0 deletions RELEASENOTES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
title: Release Notes
---

RELEASE NOTES
=============

Categories of specification change
-----------------------------------

### Major
Changes are not backwardly compatible with previous versions.
A new major version, e.g. from 2.x.y to 3.0.0

### Minor
Backward compatible changes with the current major version.
Often a new feature or extension.

### Corrections
Corrections and improvements to grammar and spelling, not intended
to change the meaning of the specification.

### Administrative:
Standard changes between versions, e.g. version number and release date.

Version 2.0.4
-------------
June 12th 2020

### Specification Changes

#### Major
None

#### Minor
None

#### Corrections
- Check schemalocations once more in the profile [[#49][], [#50][]]
- METS Profile appendix elements ID's bug [[#44][], [#46][]]

#### Administrative
- Version number increment and revision history [[#48][], [#52][]].

### Web site and PDF presentation
- Uniform site structure and DILCIS branding:
+ Archive and descriptions for profile resources [[#47][]].
+ Standard access to archive PDF versions [[#47][]].
+ Updates to Docker site production and Travis publication [[#45][], [#51][]].
- When ID contains REF linking to resource doesnt work bug [[#43][]]

[#52]: https://github.com/DILCISBoard/E-ARK-DIP/pull/52
[#51]: https://github.com/DILCISBoard/E-ARK-DIP/pull/51
[#50]: https://github.com/DILCISBoard/E-ARK-DIP/pull/50
[#48]: https://github.com/DILCISBoard/E-ARK-DIP/pull/48
[#47]: https://github.com/DILCISBoard/E-ARK-DIP/pull/47
[#46]: https://github.com/DILCISBoard/E-ARK-DIP/pull/46
[#45]: https://github.com/DILCISBoard/E-ARK-DIP/pull/45
[#49]: https://github.com/DILCISBoard/E-ARK-DIP/issues/49
[#44]: https://github.com/DILCISBoard/E-ARK-DIP/issues/44
[#43]: https://github.com/DILCISBoard/E-ARK-DIP/issues/43
89 changes: 0 additions & 89 deletions Vagrantfile

This file was deleted.

20 changes: 20 additions & 0 deletions archive/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: Archived Versions of the DIP Specification
---
Archived Versions of the DIP Specification
=============================================

Latest
------
[PDF Version 2.0.4](/pdf/eark-dip.pdf) 12-06-2020

Archived Versions
-----------------
### 2.0.x
- [PDF Version 2.0.2](v2_0/eark-dip-v2-0-2.pdf) 28-10-2019
- [PDF Version 2.0.1](v2_0/eark-dip-v2-0-1.pdf) 09-09-2019
- [PDF Version 2.0.0](v2_0/eark-dip-v2-0-0.pdf) 31-05-2019

### 1.x
- [PDF Final v1](v1/E-ARK Final Dip Specification (2017).pdf) 13-03-2017
- [PDF Draft v1](v1/E-ARK DIP Draft Specification (2015).pdf) 24-04-2015
Binary file added archive/v2_0/eark-dip-v2-0-0.pdf
Binary file not shown.
Binary file added archive/v2_0/eark-dip-v2-0-1.pdf
Binary file not shown.
Binary file added archive/v2_0/eark-dip-v2-0-2.pdf
Binary file not shown.
6 changes: 3 additions & 3 deletions create-pdf.sh
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
cd "$SCRIPT_DIR" || exit

cd "./specification/postface/"
cd "./specification/postface/" || exit
bash "$SCRIPT_DIR/spec-publisher/utils/create-venv.sh"
command -v markdown-pp >/dev/null 2>&1 || {
tmpdir=$(dirname $(mktemp -u))
tmpdir=$(dirname $"(mktemp -u)")
source "$tmpdir/.venv-markdown/bin/activate"
}
echo " - MARKDOWN-PP: Processing postface markdown"
Expand Down Expand Up @@ -41,7 +41,7 @@ cd "$SCRIPT_DIR" || exit

echo " - MARKDOWN-PP: Preparing PDF markdown"
command -v markdown-pp >/dev/null 2>&1 || {
tmpdir=$(dirname $(mktemp -u))
tmpdir=$(dirname $"(mktemp -u)")
source "$tmpdir/.venv-markdown/bin/activate"
}
markdown-pp PDF.md -o docs/eark-dip-pdf.md -e tableofcontents
Expand Down
64 changes: 60 additions & 4 deletions create-site.sh
Original file line number Diff line number Diff line change
Expand Up @@ -5,29 +5,85 @@ cd "$SCRIPT_DIR" || exit

if [ ! -d ./docs ]
then
echo " - creating docs directory"
mkdir ./docs
fi

if [ -d ./docs/figs ]
then
echo " - removing existing figs directory"
rm -rf ./docs/figs
fi

if [ -e ./docs/index.md ]
if [ -d ./docs/profile ]
then
rm docs/index.md
echo " - removing existing profile directory"
rm -rf ./docs/profile
fi

if [ -d ./docs/schema ]
then
echo " - removing existing schema directory"
rm -rf ./docs/schema
fi

if [ -d ./docs/archive ]
then
echo " - removing existing archive directory"
rm -rf ./docs/archive
fi

if [ -d ./docs/_data ]
then
echo " - removing existing menu data"
rm -rf ./docs/_data
fi

if [ -d ./docs/_includes ]
then
echo " - removing existing includes"
rm -rf ./docs/_includes
fi

if [ -d ./docs/_layouts ]
then
echo " - removing existing layouts"
rm -rf ./docs/_layouts
fi

if [ -d ./docs/img ]
then
echo " - removing existing images"
rm -rf ./docs/img
fi

if [ -d ./docs/css ]
then
echo " - removing existing css"
rm -rf ./docs/css
fi

if [ -d ./docs/release-notes ]
then
echo " - removing existing release notes"
rm -rf ./docs/release-notes
fi
mkdir ./docs/release-notes
cp ./RELEASENOTES.md ./docs/release-notes/index.md

bash "$SCRIPT_DIR/spec-publisher/utils/create-venv.sh"
command -v markdown-pp >/dev/null 2>&1 || {
tmpdir=$(dirname $(mktemp -u))
tmpdir=$(dirname $"(mktemp -u)")
source "$tmpdir/.venv-markdown/bin/activate"
}
markdown-pp SITE_BASE.md -o /tmp/site.md
markdown-pp SITE.md -o ./docs/index.md

cp -R specification/media docs/
cp -Rf spec-publisher/site/* docs/
find ./docs/_* -type f -exec sed -i 's/CSIP/DIP/' {} \;
find ./docs/_* -type f -exec sed -i 's/csip/dip/' {} \;
cp -R spec-publisher/res/md/figs docs/
cp -R specification/media docs/
cp -R profile docs/
cp -R archive docs/
cp -R examples docs/
1 change: 0 additions & 1 deletion docs/Gemfile
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
source 'https://rubygems.org'
gem 'github-pages', group: :jekyll_plugins
gem "jekyll-theme-primer", group: :jekyll_plugin
3 changes: 1 addition & 2 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,11 @@ kramdown:
hard_wrap: false
future: true
jailed: false
theme: jekyll-theme-primer
gfm_quirks: paragraph_end
repository: DILCISBoard/E-ARK-DIP
plugins:
- jekyll-github-metadata
- jekyll-mentions
- jekyll-redirect-from
- jekyll-sitemap
- jekyll-redirect-from
- jemoji
8 changes: 4 additions & 4 deletions pandoc/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,18 @@ abstract: |
margin-left: 1in
margin-right: 1in

date: "31.05.2019"
date: "12.06.2020"
toc-title: 'Table of contents'
titlepage: true
titlepage-color: "186b9e"
titlepage-text-color: "3adeca"
titlepage-rule-color: "3adeca"
titlepage-rule-height: 1
logo: ../spec-publisher/pandoc/img/DILCISlogo.png
footer-center: Version 2.0.0
footer-left: 31.05.2019
footer-center: Version 2.0.4
footer-left: 12.06.2020
header-right: DILCIS Board
version: 2.0.0
version: 2.0.4
bibliography: ../pandoc/bibliography.bib
reference-section-title: 'Bibliography'
autoSectionLabels: True
Expand Down
Loading

0 comments on commit 1e5841d

Please sign in to comment.