Skip to content

Commit

Permalink
Merge pull request #88 from DILCISBoard/rel/v2.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 1066680 + 87c8ec0 commit c5cc12e
Show file tree
Hide file tree
Showing 25 changed files with 3,452 additions and 179 deletions.
16 changes: 13 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
.DS_Store
# Site publication file
docs/
site/
Gemfile.lock
**/_site
.classpath
.project
.settings
**/*.jar
**/target
**/bin
**/*.class
.vagrant*
.venv
Gemfile.lock
specification/eark-sip-pdf.md
vendor
32 changes: 16 additions & 16 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,33 +3,33 @@ sudo: required
language: java
jdk:
- openjdk8
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-SIP.xml
- cd ..
- bash create-site.sh
- 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 stash
- git checkout feat/pdf-publication
- mvn clean package
- java -jar target/mets-profile-proc.jar ../profile/E-ARK-SIP.xml
- cd ..
- 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 jekyll build -s ./docs -d ./_site
- bash create-pdf.sh
- bundle exec htmlproofer ./site --file-ignore /javadoc/ --only-4xx --check-html
- ls -alh ./docs
- ls -alh ./site
- grep -i "github.com" --group-separator"===== GH REF =====" -n -B 1 -A 1 site/index.html
deploy:
provider: pages
skip_cleanup: true
github_token: "$GH_TOKEN"
keep_history: true
local_dir: docs
fqdn: earksip.dilcis.eu
local_dir: site
fqdn: "$CNAME"
on:
branch: master
env:
Expand Down
64 changes: 64 additions & 0 deletions RELEASENOTES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
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
- Fixed issues with duplicate and obtuse METS Appendix IDs [[#73][], [#76][]].
- Update in image to reflect name change of CITS Geodata [[#74][]].
- Fixed representation folder labels for Fig. 2 and Fig. 7 [[#81][], [#82][]].
- Fixed references in requirements text [[#84][]]

#### Administrative
- Version number increment and revision history [[#77][], [#85][]].

### Web site and PDF presentation
- Uniform site structure and DILCIS branding:
+ Archive and descriptions for profile resources [[#78][]].
+ Standard access to archive PDF versions [[#78][]].
+ Updates to Docker site production and Travis publication [[#79][]].
- Anchors in descriptions to elements with ID starting with REF [[#72][]].

[#85]: https://github.com/DILCISBoard/E-ARK-SIP/pull/85
[#84]: https://github.com/DILCISBoard/E-ARK-SIP/pull/84
[#82]: https://github.com/DILCISBoard/E-ARK-SIP/pull/82
[#81]: https://github.com/DILCISBoard/E-ARK-SIP/pull/81
[#79]: https://github.com/DILCISBoard/E-ARK-SIP/pull/79
[#78]: https://github.com/DILCISBoard/E-ARK-SIP/pull/78
[#77]: https://github.com/DILCISBoard/E-ARK-SIP/pull/77
[#76]: https://github.com/DILCISBoard/E-ARK-SIP/pull/76
[#74]: https://github.com/DILCISBoard/E-ARK-SIP/issues/74
[#73]: https://github.com/DILCISBoard/E-ARK-SIP/issues/73
[#72]: https://github.com/DILCISBoard/E-ARK-SIP/issues/72
92 changes: 0 additions & 92 deletions Vagrantfile

This file was deleted.

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

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

Archived Versions
-----------------
### 2.0.x
- [PDF Version 2.0.3](v2_0/eark-sip-v2-0-3.pdf) 08-01-2020
- [PDF Version 2.0.2](v2_0/eark-sip-v2-0-2.pdf) 28-10-2020
- [PDF Version 2.0.1](v2_0/eark-sip-v2-0-1.pdf) 09-09-2020
- [PDF Version 2.0.0](v2_0/eark-sip-v2-0-0.pdf) 31-05-2020

### 1.4
- [WORD Version 1.4](v1.4.0/General_SIP Specification_v1.4.docx) 31-01-2017
- [PDF Version 1.4](v1.4.0/General_SIP Specification_v1.4.pdf) 31-01-2017
Binary file removed archive/v1.4.0/~$neral_SIP Specification_v1.4.txt
Binary file not shown.
Binary file added archive/v2_0/eark-sip-v2-0-0.pdf
Binary file not shown.
Binary file added archive/v2_0/eark-sip-v2-0-1.pdf
Binary file not shown.
Binary file added archive/v2_0/eark-sip-v2-0-2.pdf
Binary file not shown.
Binary file added archive/v2_0/eark-sip-v2-0-3.pdf
Binary file not shown.
41 changes: 41 additions & 0 deletions create-site.sh
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,44 @@ then
rm docs/index.md
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)")
Expand All @@ -39,6 +77,9 @@ markdown-pp SITE.md -o ./docs/index.md

rm /tmp/site.md

cp -Rf spec-publisher/site/* docs/
find ./docs/_* -type f -exec sed -i 's/CSIP/SIP/' {} \;
find ./docs/_* -type f -exec sed -i 's/csip/sip/' {} \;
cp -R specification/images docs/
cp -R spec-publisher/res/md/figs docs/
cp -R profile docs/
Expand Down
6 changes: 6 additions & 0 deletions examples/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Example E-ARK Submission Information Packages
---
Example E-ARK Submission Information Packages
=============================================
- [An E-ARK SIP example](a46ab3d0-c710-4d73-b58d-e93e30b53a82.zip)
Loading

0 comments on commit c5cc12e

Please sign in to comment.