Development Setup

Adding a new capability

To add a new scan to gitlabctl, providing new enumeration capabilities to security operators everywhere, please see the adding a new capability page.

Setting up your development environment

If you've just cloned gitlabctl for the first time, welcome to the community! We use Palantir's godel to streamline local development and goreleaser to handle the heavy lifting on the release process.

To get started with godel, you can run

./godelw verify

This will run a number of checks for us, including linters, tests, and license checks. We run this command as part of our CI pipeline to ensure the codebase is consistently passing tests.

Building the CLI

We can use godel to build our CLI locally by running

./godelw build

You should see output in out/build/gitlabctl/<version>/<os>-<arch>/gitlabctl.

If you'd like to clean this output up, you can run

./godelw clean

Testing releases locally

We can use goreleaser locally as well to test our builds. As gitlabctl uses cosign to sign our artifacts and Docker containers during our CI pipeline, we'll want to skip this step when running locally.

goreleaser release --snapshot --clean --skip sign

This should output binaries, distributable tarballs/zips, as well as docker images to your local machine's Docker registry.