Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable documentation deployment in Azure Pipelines Linux CI #1337

Merged
merged 6 commits into from
Sep 11, 2019

Conversation

seisman
Copy link
Member

@seisman seisman commented Aug 8, 2019

I made some changes to the document deployment script from https://github.com/fatiando/continuous-integration/blob/master/travis/deploy-gh-pages.sh.

I tested it with another repository and it worked well.

@leouieda Can you review it?

@seisman seisman requested a review from leouieda August 8, 2019 22:46
@leouieda
Copy link
Member

leouieda commented Aug 8, 2019

@seisman thanks for doing this! Did you add the token through the web interface? Also, did you check if it's not being leaked anywhere in the log? This token gives full access to all of your repositories (including the GMT ones).

Should we enable building this branch temporarily as if it were 6.0 to test that it works? Otherwise we'll have to wait for the scheduled build.

@seisman
Copy link
Member Author

seisman commented Aug 9, 2019

@leouieda I added a fake token through the web interface. The log looks secure to me.

bash ci/deploy-gh-pages.sh
========================== Starting Command Output ===========================
[command]/bin/bash --noprofile --norc /home/vsts/work/_temp/1cce2eed-949b-493a-be46-9dffe13dbca9.sh
Not in master or 6.x branches. Deployment skipped.
+ REPO=GenericMappingTools/gmt
+ BRANCH=gh-pages
+ CLONE_DIR=deploy
+ CLONE_ARGS='--quiet --branch=gh-pages --single-branch'
+ REPO_URL=https://***@github.com/GenericMappingTools/gmt.git
+ HTML_SRC=/home/vsts/work/1/s/build/doc/rst/html
+ [[ azure-deploy-docs =~ ^6\.[0-9]+$ ]]
+ [[ azure-deploy-docs == \m\a\s\t\e\r ]]
+ echo -e 'Not in master or 6.x branches. Deployment skipped.'
+ exit 0

Copy link
Member

@leouieda leouieda left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@seisman looks good to me. A few things to consider:

  • Be sure to turn it off in Travis so we don't deploy twice
  • Make sure the job runs on tag builds, not just scheduled builds of master/6.0

@seisman
Copy link
Member Author

seisman commented Sep 10, 2019

Be sure to turn it off in Travis so we don't deploy twice

Travis CI is only used to deploy documentations. So now it's OK to fully drop Travis CI in 2975450.

Make sure the job runs on tag builds, not just scheduled builds of master/6.0

Currently, we do nothing for a new tag, even don't trigger any builds for a new tag. I think we can leave it to another PR. BTW, we will update/deploy the documentations nightly, so building documentations on tag builds won't make many differences.

@leouieda
Copy link
Member

we will update/deploy the documentations nightly, so building documentations on tag builds won't make many differences.

That's true. Are all version branches updated nightly?

@seisman
Copy link
Member Author

seisman commented Sep 11, 2019

Yes, both master and 6.0 are updated nightly.

@leouieda
Copy link
Member

Alright, this is fine by me then. Merge when you're ready.

@seisman seisman merged commit 5bd7cb8 into 6.0 Sep 11, 2019
@seisman seisman deleted the azure-deploy-docs branch September 11, 2019 14:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants