Getting Started: GitLab

Connect your GitLab repository with Stapsher

Stapsher’s Public API uses a GitLab Bot account for managing your site’s repository on GitLab.

Step 1: Add stapsher as a project member

Go to your GitLab project’s Settings > Members > Add member:

Add stapsher as GitLab project member

Add stapsher as a member with minimum role permission of Developer.

If you’re using a Protected branch, make sure stapsher is allowed to push.

Step 2: Add configuration file: stapsher.yaml

Stapsher looks for stapsher.yaml at the root of your site’s repository. You can fine-tune Stapsher’s behavior in this file.

Take a look at the sample configuration file: stapsher.yaml Sample

You can use it as is. Or change and extend it according to your need.

You can find all the available configuration options here: stapsher.yaml Options

Step 3: Prepare your HTML Forms

For using Stapsher with your site’s HTML Forms, check:

Usage with HTML Forms


You’re all set!