Sourcemod-CI-Dockerfile

A docker sourcemod plugins build environment, based on debian

Usage

You can pull this image as you normally do with docker from Docker-Hub https://hub.docker.com/r/rays3t/sourcemod-plugins-builder-ci/

docker pull rays3t/sourcemod-plugins-builder-ci

Use together with GitLab runner

If you want to use this docker image for your sourcemod plugins, using GitLab, here some short notes how to.

.gitlab-ci.yml

GitLab uses a .yml configuration file for the runner configuration. If you completly new to this, have a look at the docs over at GitLab.

This docker images adds a little wrapper script for the script compile precedure, which is callable by simply running the spcom command (registered as symlink to the real script). The script is basically looking for *.sp files in the build directory and compiles those.

So all you have to do in your .gitlab-ci.yml is invoking the command "spcomp" after the docker machine is started. This will then start the compilation of your plugins.

Working directory

The default working directory is the GitLab checkout dir. We retrive this from the environment variable CI_PROJECT_DIR which is set by gitlab. If you want to use a different one, you can simple set an environment variable called BUILD_DIR This will then be used by the compile script as working directory.

Automatic version replacement

You can use placeholder like // ${-version-define-} or ${-version-} in your code. This will be replaced with the last recent git tag name or commit hash.

The commit hash is used if git describe results in an error.

The first method adds a new define like #define GIT_VERSION "v0.1" while the second one just replaces the placeholder itself

To use ths feature, you have to set the environment variable AUTO_VERSION_REPLACE=1

This way you don't have to worry about version numbers. Just create a new tag in git, the runner will build it and blub there is your version of the plugin.

Example build file for plugins using this

You simply create you repository including you plugin(s).sp and maybe an include/ folder for third-party (.inc) includes.

Then you add this file called .gitlab-ci.yml to the repository. Sime as it it, gitlab will build your plugin and provide a downloadable archive for it.

image: rays3t/sourcemod-plugins-builder-ci
build:
    stage: build
## If you want to replace version numbers, uncomment this section:
##  variables:
##      AUTO_VERSION_REPLACE: '1'
    script: spcomp
    artifacts:
        name: "${CI_PROJECT_NAME}_${CI_COMMIT_REF_NAME}"
        paths:
        - compiled/*

If you are just compiling a single plugin you could change the path from the "artifact" to point directly on the compiled/plugin_name.smx file to download it directly