...
Create a personal github access token with
public_repo
permission only to allow travis to deploy the java docs to thegh-pages
branch. Instructions can be found here . This has already been done for the OpenSRP projects. No need to create another one at the moment.Configure a publishing source for the github pages site using directions provided here
If the site has not published i.e you cannot view the projects Readme contents on http://smartregister.org/ {project repo name} , the admin should make a blank commit & push on the
gh-pages
branch for the project using this commandgit commit -S -m "Trigger CI" --allow-empty
. After the push, the contents of the project's Readme files should be displayed on http://smartregister.org/ {project repo name} url.Encrypt the gitub token generated on step 1 using the following command
travis encrypt GITHUB_TOKEN=actual_github_access_token
. Note that this step has to be done in the project directory itself. Encrypted travis values cannot be shared between projectsYou need
travis
installed on your local environment. Use the following commands:Ubuntu :-
Code Block sudo apt install ruby ruby-dev sudo gem install travis
Mac : -
Code Block brew install ruby gem update --system gem install travis -v 1.8.8 --no-rdoc --no-ri
The following details steps for setting up travis to generate and publish javadocs to github pages. This can be done by any developer.
...