Build and publish on GitLab

Enable GitLab Pages for the project. Open your project on GitLab, select Settings | General, expand the Visibility, project features, permissions section, and enable Pages.

In the writerside.cfg file, set the web-path parameter for images to img.

<ihp version="2.0">
    <topics dir="topics"/>
    <images dir="images" web-path="img"/>
    <instance src="hi.tree"/>
</ihp>

In the project root, create a file named .gitlab-ci.yml, where you will define your CI/CD pipeline.

The following sample pipeline will trigger on every push to the main branch in the repository. the pipeline builds, tests, and publishes documentation from the starter project, where the default module name is Writerside and the default instance ID is hi:

.gitlab-ci.yml
 {...}

If necessary, set the correct values for environment variables:

INSTANCE

The name of the module and instance ID separated by a slash. The module name is the directory with writerside.cfg. It is designated by the icon in the Project tool window.

For example, the default module name in a starter project is Writerside and the instance ID is hi. So in this case, set the variable to Writerside/hi.

note

If you want to build multiple instances, set IS_GROUP: 'true' and make sure the INSTANCE variable points to the necessary build group.

Also, in this case, save the artifacts to path: artifacts/*.

DOCKER_VERSION

The version of the Writerside Docker builder to use for generating the documentation artifacts. The current latest version is 2025.04.8412.

When you update to a newer version of Writerside, set the new Docker builder version to ensure results similar to what you see in the local preview and local builds.

Commit the .gitlab-ci.yml and push it to GitLab.