CI-CD Demo

Gitlab

This repository demonstrates how to use docToolchain within a gitlab CI/CD pipeline.

.gitlab-ci.yml

link:.gitlab-ci.yml[role=include]

Just add the .gitlab-ci.yml file to the root of your project, and you’re ready to go.

To find the URL for your new microsite, navigate to Settings > Pages.

https://doctoolchain.gitlab.io/ci-cd-demo/

Note	Gitlab has a special feature which github is missing: you can change the visibility of the microsite. Go to Settings > General > Visibility. There you can restrict the visibility to project members only.

Github

…​and within a Github Action workflow:

.github/workflows/gh-pages.yml

link:.github/workflows/gh-pages.yml[role=include]

Add the file above to your project and and wait for the first run of the github action. This will create a new branch called gh-pages. It contains the HTML source of your microsite.

Now you have to tell github to deploy these sources to the server. Got to Settings > Pages and set as Source the gh-pages branch.

Now wait until the deployment is finished. The URL for your microsite is displayed in the green box of the settings page.

http://doctoolchain.org/ci-cd-demo/

Warning

Github pages are always public - even if your repository is private.