Opened 9 years ago
Closed 7 years ago
#1620 closed enhancement (fixed)
Create a Travis continuous integration script for documentation
Reported by: | kalxas | Owned by: | cvvergara |
---|---|---|---|
Priority: | critical | Milestone: | OSGeoLive12.0 |
Component: | OSGeoLive | Keywords: | docs |
Cc: | live-demo@… |
Description
Since the documents are now hosted under git (and mirrored on GitHub) we can take advantage of the Travis continuous integration capabilities and catch any build errors before merging new code.
Change History (15)
comment:1 by , 9 years ago
Milestone: | OSGeoLive9.5 → OSGeoLive10.0 |
---|
comment:2 by , 9 years ago
Resolution: | → wontfix |
---|---|
Status: | new → closed |
comment:3 by , 9 years ago
Resolution: | wontfix |
---|---|
Status: | closed → reopened |
comment:4 by , 8 years ago
Milestone: | OSGeoLive10.0 → OSGeoLive10.5 |
---|
comment:5 by , 8 years ago
As per http://osgeo-org.1560.x6.nabble.com/OSGeoLive-10-0-status-rc1-td5277519.html what is the status of this process? It would be valuable to have a continuous deployment of the docs to http://adhoc.osgeo.osuosl.org/livedvd/docs/en/index.html. This would make things much easier for contributors to review.
comment:6 by , 8 years ago
I agree. Unfortunately, the build cron job is broken due to changes to the Makefile.
We should be using the daily launchpad builds now for doc preview:
comment:9 by , 8 years ago
An idea of how this can be done: A .travis.yml is needed and the steps:
- Operative system for the test
- Install: the necessary packages to generate the documentation
- Script or after_success: execute the process to make the documentation
if in "Script" and there are errors then the build fails if in "after_success" and there are errors the build pass
When I added the translation for pgRouting quickstart I saw that making the documentation generates a lot of errors, So, my suggestion is first make the documentation error free, before putting it in the "script" stage.
When does that get tested: if the user has a travis account, it will start the test in his account. when a pull request is done it will start the the travis in the account of the repository where its requested.
These lines test the documentation of pgRouting generated with sphinx (only the html and in the after_success) https://travis-ci.org/cvvergara/pgrouting/jobs/147340825#L1751
comment:10 by , 8 years ago
Consider also testing the Gogs-associated Drone service: drone.osgeo.kbt.io (currently hosted by myself but we might move it to OSGeo machines one day) -- you can login with your OSGeo Userid.
comment:11 by , 8 years ago
Milestone: | OSGeoLive10.5 → OSGeoLive11.0 |
---|
Ticket retargeted after milestone closed
comment:12 by , 7 years ago
Owner: | changed from | to
---|---|
Status: | reopened → new |
This is already implemented as part of the work done by Vicky in her development branch:
https://github.com/cvvergara/OSGeoLive-doc/commits/test/sphinx
comment:13 by , 7 years ago
Milestone: | OSGeoLive11.0 → OSGeoLive12.0 |
---|---|
Priority: | major → critical |
comment:14 by , 7 years ago
The ticket is about travis for documentation, and that is done. Any more contents of travis, open a new ticket.
Ticket retargeted after milestone closed