Skip to content

Commit

Permalink
Updated new release instructions.
Browse files Browse the repository at this point in the history
  • Loading branch information
hjoliver committed Feb 7, 2018
1 parent 3bf9a65 commit ec71da4
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 8 deletions.
20 changes: 20 additions & 0 deletions admin/README.update-docs
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
From the release branch (usually master) generate new PDF and HTML docs, and
copy the doc/install/ directory to $HOME.

Checkout gh-pages and run this script:

rm -r doc html
mkdir doc
cp ~/install/cylc-user-guide.pdf doc/
cp ~/install/suite-design-guide.pdf doc/
for f in ~/install/html/{single,multi}/*.{html,css}; do
F=${f#*install/}
mkdir -p $(dirname $F)
echo cp $f $F
done

Finally:

git checkout -- doc/cylc-autosub-response.pdf

git add any new files under html/
4 changes: 4 additions & 0 deletions admin/README.update-live-page
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
NOTE: the cylc repository side-bar information (latest release, recent
releases,...) will not be regenerated unless the source files change, which
they don't because we extract the latest release info automatically. To force
this, make some dummy change (e.g. whitespace) to _includes/repository.html.
17 changes: 9 additions & 8 deletions admin/new-release.README
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@

How to generate a new cylc release and update the cylc homepage (on
github gh-pages):
How to generate a new cylc release and update the cylc
homepage (on GitHub gh-pages):

1 run the test battery
2 update doc/changes.html and commit the change
3 tag with the new release number x.y.z
4 push new commit and the tag to master on cylc/cylc
5 generate the new documentation and update it to gh-pages:
1 run the test battery locally one more time (Travis CI
should already pass).
2 update CHANGES.md and commit the change
3 tag the new release:
git tag -a x.y.z 'Release x.y.z'
4 push new commits and tag to cylc/cylc:master
5 generate new docs and update to gh-pages, as described in the README.update-*

% admin/update-gh-pages -p "release x.y.z"

0 comments on commit ec71da4

Please sign in to comment.