Generate gh-pages documentation once new commits are pushed to master #1106
Conversation
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
This script will allow the generation of the documentation, right now is a quick and dirty bash script. It generates a .html and a file with the date (YYYMMDD) and the short name for the commit as filename.
This is the start for travis to become a bit more useful, it will now be able to commit to the repository (A deploy key should be added in the os-autoinst/openQA repository) Deploy key is contained in .openqa-travis.enc At this point is not fully working yet.
With this commit, documentation will be generated after the build is complete From here, the docs present in openqa/docs and (in the future os-autoinst/docs) will be generated in a web-browseable format.
foursixnine
force-pushed
the
doc/generator_script
branch
from
5b9959f
to
0050135
Compare
|
Looks like travis builds will fail until the key is added :) |
|
there is more work to do -> #1110 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
With this PR we get the documents being built and auto published by travis on the gh-pages branch, which will automatically regenerate the website http://open.qa
The website will look like this:
Upon generation there's a single PDF and HTML file with all the content from the docs/ directory and automatically linked to /docs/current.pdf or /docs/index.html.
There is also documentation generated from testapi.pm (for now, more to come by using auto-generated pod :) sometime in the future)
The file
.openqa-travis.enccontains a deploy key generated using the following procedure with a deploy key for foursixnine/openQA (and i hope that gh's security team and travis are very keen on security :) because of $reasons)This means: Somebody will need to create a deploy-key/ssh-key replace
.openqa-travis.encwith the newly created ssh-private-key and then add the ssh public key on os-autoinst/openQA settings as a deploy keyThe generate-documentation script can be used also standalone, but requires that the user has asciidoctor installed (at least, the pdf generation will fail if asciidoctor-pdf is not installed, see the .travis.yml for reference)
As the testapi will not change that often (And honestly makes no sense), the Pod documentation will be generated only under a travis environment (therefore, the hardcoded
cpanm --install), however, the script can be called standalone too... provided that there's a directory named src/ and the .pm files are there... with their inline pod present.This PR requires #1105