Skip to content

Commit 7c8c17b

Browse files
committed
[ re #1274 ] documenting the generation of documentation
1 parent 0a450fc commit 7c8c17b

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

notes/release-guide.txt

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,29 @@ procedure should be followed:
6161
* Announce the release of the new version on the Agda mailing lists
6262
(users and developers).
6363

64+
* Add v$VERSION to the list of protected directories in the .travis.yml
65+
file of BOTH master and experimental. They should look something like:
66+
67+
> git checkout HEAD -- v0.16/ v0.17/ v1.0/ v1.1/ (...)
68+
69+
Commit & push these changes. This will prevent the next step from being
70+
overwritten by travis.
71+
72+
* Generate and upload documentation for the released version:
73+
74+
cp travis/* .
75+
runhaskell GenerateEverything.hs
76+
./index.sh
77+
agda -i. -isrc --html index.agda
78+
mv html v$VERSION
79+
git checkout gh-pages
80+
git add v$VERSION/*.html v$VERSION/*.css
81+
git commit -m "[ release ] doc for version $VERSION"
82+
git push
83+
84+
After that you can cleanup the generated files and copies of things taken from travis/
85+
from your agda-stdlib directory.
86+
6487
#### Post-release
6588

6689
* Move the CHANGELOG.md into the old CHANGELOG folders

0 commit comments

Comments
 (0)