Opened 3 years ago

Closed 22 months 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 Changed 3 years ago by kalxas

Milestone: OSGeoLive9.5OSGeoLive10.0

Ticket retargeted after milestone closed

comment:2 Changed 3 years ago by kalxas

Resolution: wontfix
Status: newclosed

comment:3 Changed 3 years ago by kalxas

Resolution: wontfix
Status: closedreopened

comment:4 Changed 3 years ago by kalxas

Milestone: OSGeoLive10.0OSGeoLive10.5

comment:5 Changed 3 years ago by tomkralidis

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 Changed 3 years ago by kalxas

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:

https://launchpad.net/~osgeolive/+archive/ubuntu/docs

comment:7 Changed 3 years ago by tomkralidis

How can we fix this?

comment:8 Changed 3 years ago by kalxas

Sorry, I am not the owner of that cron job and I do not have access.

comment:9 Changed 3 years ago by cvvergara

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 Changed 3 years ago by strk

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 Changed 23 months ago by kalxas

Milestone: OSGeoLive10.5OSGeoLive11.0

Ticket retargeted after milestone closed

comment:12 Changed 23 months ago by kalxas

Owner: changed from live-demo@… to cvvergara
Status: reopenednew

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 Changed 23 months ago by kalxas

Milestone: OSGeoLive11.0OSGeoLive12.0
Priority: majorcritical

comment:14 Changed 22 months ago by cvvergara

The ticket is about travis for documentation, and that is done. Any more contents of travis, open a new ticket.

comment:15 Changed 22 months ago by kalxas

Resolution: fixed
Status: newclosed

Thanks Vicky!

Note: See TracTickets for help on using tickets.