-
Notifications
You must be signed in to change notification settings - Fork 94
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
33 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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" |