I just wrote about how I started to self host Sphinx sites on Azure App Service. Here I am writing about how to set up CI/CD pipeline to make it perfect.
It is very important to learn Azure App Service, so as to know what built-in features we can use.
Clearly here I need to set its deployment method to a custom repo on VSTS (I cannot use GitHub or others because I need to handle private repos).
So I create a new project on Azure called AzureSites, a new repo under it called production, and hook my App Service to it by following this article.
Note that I did not use VSTS pipeline here, because I need to handle it later.
I had to create a second repo here called AllSites, because too many web sites are there to integrate, and each of them have their own repos (mostly on GitHub).
So in AllSites I added all such repos as submodules, and it looks like this,
I also added AzureSites as a submodule, so later I can copy all web pages into it.
Then I went ahead to create a pipeline for the master repo,
- It checks out all submodules and executes their builds.
- Copy all web pages to AzureSites submodule.
- Commit changes in AzureSites and push it.
Note that Azure App Service will automatically pick up the changes from AzureSites, and we are done.
What if now I modified one of the Sphinx sites? How can this pipeline pick up the changes? That’s a good question. To solve the challenges, we need a few things,
- Create your Zapier account and set up a Zap to trigger a VSTS build from the pipeline above, when a GitHub repo sees a commit. (You can use other similar services too.)
- Add a task to the pipeline (usually the first step) to call git pull on all Sphinx submodules. In this way, all latest commits can be downloaded.
- After pushing AzureSites, we should also stage the changes on the master repo and push it back.
Note that free account on Zapier can only monitor five GitHub repos in this case, so I only monitored the most important ones.
I also added a Zap to monitor my own Twitter feed, so if I write a magic tweet a build would be triggered.
I still keep a daily build trigger in VSTS, in case I run out of Zapier free count (100 per month).
You might find it a waste of resources to always run the tasks in pipeline, if no submodule changes.
I showed you a way to abort the execution early in a separate post.