-
Notifications
You must be signed in to change notification settings - Fork 25
Release procedure
Yannick Warnier edited this page May 14, 2026
·
8 revisions
When a new version is ready, make sure you run the scripts/tag-release.php script to update CHANGELOG.md and generate the new tag, then tag the release:
php scripts/tag-release.php
git push origin 2.x-v{x}
Translate to other languages:
mkdir translated
php scripts/translate-docs.php --from 2.x-v1 {fr_FR}
# create the language-specific branch if necessary with git checkout -b 2.x-{lang}
#git checkout 2.x-fr && rsync -av translated/fr_FR/ ./ && git add -A -- ':!translated/'
git checkout 2.x-fr
rsync -av translated/fr_FR/ ./
git commit -m "Translation from en" README.md SUMMARY.md admin-guide developer-guide teacher-guide
git push origin 2.x-fr
git tag -a 2.x-fr-v1 -m "New translation from 2.x-v1"
git push origin 2.x-fr-v1
git checkout 2.x
If any single file failed, use the --single-file option:
php scripts/translate-docs.php --force --single-file teacher-guide/assessing-learners/exercises.md fr_FR
To declare a new language on Gitbook:
- login
- In "Spaces" > "Chamilo" > "+" > "New space"
- "Sync with git"
- "GitHub Sync"
- "Connect with GitHub"
- Select account
- Select repository ("docs")
- Select branch (the last one)
- Initial sync: GitHub to GitBook
- Sync progress (wait for a few seconds) > "View space"
- In "Spaces" > "Untitled" > "Select language" > "Rename" > "Chamilo 2 {LANG}"
- Docs sites > Chamilo > Manage site structure > + New > Variant > Select the repo and set the Slug to "2.x-{lang}"