Skip to content

Commit

Permalink
Update release_checklist_task_force.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dan-zeman authored Nov 15, 2016
1 parent 66264e5 commit 84cefd9
Showing 1 changed file with 21 additions and 20 deletions.
41 changes: 21 additions & 20 deletions release_checklist_task_force.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,42 +39,43 @@ See [here](release_checklist.html) for the checklist for data contributors.
that should not be released (`.gitignore`, `.git`, `not-to-release`). The training data in UD_Czech is split to four files
because it is too large for Github. However, it can be one file in our release, so join the files again in the release
copy.<br />
<code>mkdir release-1.3<br />
cd release-1.3<br />
mkdir ud-treebanks-v1.3<br />
cd ud-treebanks-v1.3<br />
<code>mkdir release-1.4<br />
cd release-1.4<br />
mkdir ud-treebanks-v1.4<br />
cd ud-treebanks-v1.4<br />
for i in ../../UD_* ; do if [ -f $i/*-ud-train.conllu ] ; then echo $i ; cp -r $i . ; fi ; done<br />
cp -r ../../UD_Czech .<br />
cat UD_Czech/cs-ud-train-*.conllu > UD_Czech/cs-ud-train.conllu<br />
rm UD_Czech/cs-ud-train-*.conllu<br />
rm -rf UD_*/.git* UD_*/not-to-release<br />
cd ..<br />
tar czf ud-treebanks-v1.3.tgz ud-treebanks-v1.3<br />
tar czf ud-treebanks-v1.4.tgz ud-treebanks-v1.4<br />
cd ..</code>
* Prepare the current content of the tools repository as a separate package, also without `.git` and `.gitignore`.<br />
<code>pushd tools ; git pull --no-edit ; popd<br />
cd release-1.3<br />
mkdir ud-tools-v1.3<br />
cp -r ../tools/* ud-tools-v1.3<br />
rm -rf ud-tools-v1.3/.git* ud-tools-v1.3/not-to-release<br />
tar czf ud-tools-v1.3.tgz ud-tools-v1.3<br />
cd release-1.4<br />
mkdir ud-tools-v1.4<br />
cp -r ../tools/* ud-tools-v1.4<br />
rm -rf ud-tools-v1.4/.git* ud-tools-v1.4/not-to-release<br />
tar czf ud-tools-v1.4.tgz ud-tools-v1.4<br />
cd ..</code>
* Prepare the current content of the docs repository as a separate package, also without `.git` and `.gitignore`. Note that this is archiving the MarkDown _source code_ of the documentation. See below for archiving the corresponding HTML.<br />
<code>pushd docs ; git checkout pages-source ; git pull --no-edit ; popd<br />
cd release-1.3<br />
mkdir -p ud-documentation-v1.3/markdown-source<br />
cp -r ../docs/* ud-documentation-v1.3/markdown-source<br />
rm -rf ud-documentation-v1.3/markdown-source/.git* ud-documentation-v1.3/markdown-source/not-to-release<br />
cd release-1.4<br />
mkdir -p ud-documentation-v1.4/markdown-source<br />
cp -r ../docs/* ud-documentation-v1.4/markdown-source<br />
rm -rf ud-documentation-v1.4/markdown-source/.git* ud-documentation-v1.4/markdown-source/not-to-release<br />
cd ..</code>
* The surface form of documentation (i.e. the web content visible to the reader) is automatically generated in a separate Github repository. WARNING! Many folders contain generated files `AUX.html` and `aux.html` (besides `AUX_.html` and `aux_.html`). These should _not_ be included in the package because that might prevent people from unpacking it in MS Windows (although some unpacking programs, like 7zip, will be able to overcome this by simply renaming the file to `_aux.html` before unpacking it). Note furthermore that we currently cannot force Jekyll (the page generator) to make all hyperlinks relative in order for the pages to work well offline. Many hyperlinks will be broken when viewing the pages, and the user will have to open individual pages from the file manager instead. However, it may still be useful to provide the HTML rendering, especially because of the embedded tree visualizations.<br />
<code>git clone [email protected]:UniversalDependencies/universaldependencies.github.io.git<br />
cd release-1.3<br />
mkdir -p ud-documentation-v1.3/html<br />
cp -r ../universaldependencies.github.io/* ud-documentation-v1.3/html<br />
rm -rf ud-documentation-v1.3/html/.git* ud-documentation-v1.3/html/not-to-release<br />
rm -f ud-documentation-v1.3/html/*/*/{AUX,aux}.html<br />
tar czf ud-documentation-v1.3.tgz ud-documentation-v1.3<br />
cd release-1.4<br />
mkdir -p ud-documentation-v1.4/html<br />
cp -r ../universaldependencies.github.io/* ud-documentation-v1.4/html<br />
rm -rf ud-documentation-v1.4/html/.git* ud-documentation-v1.4/html/not-to-release<br />
rm -f ud-documentation-v1.4/html/*/*/{AUX,aux}.html<br />
tar czf ud-documentation-v1.4.tgz ud-documentation-v1.4<br />
cd ..</code>
* Make the release packages temporarily available for download somewhere and ask the treebank providers to check them before we archive them in Lindat.
* Tag the current commit in all repositories with the tag of the current release (`git tag r1.3` for UD 1.3).
Push the tag to Github: `git push origin --tags`.
You may even tag a particular commit retroactively: `git tag -a r1.3 9fceb02`.
Expand Down

0 comments on commit 84cefd9

Please sign in to comment.