CONTRIBUTING.md

Contributing to Tugboat

Building Local Containers

Stop local container and reset build state:

./clean.sh

Build local container:

./package.sh

Applying Security Updates

• Update container.dockerfile when new Ubuntu base versions become available
• Let apt update and apt upgrade do the heavy lifting
• Scan the container image: trivy image tugboat:6.3.0

GitHub Workflow

This workflow allows you to easily create your own copy of tugboat, try out some changes, and then share your changes back to be merged, with feedback from other contributors.

1. Create a fork of robfromboulder/tugboat
2. Create a feature branch
3. Build and test local changes
4. Commit changes to your feature branch
5. Open a pull request
6. Participate in code review
7. Celebrate your accomplishment

Container Versioning

• Your local builds will always be versioned 6.3.0 (and this is assumed by build scripts)
• Public release numbers use the installed Graylog version and a patch version like this: 6.3.beta1 (for 1st beta) or 6.3.0c (for 3rd build of 6.3.0)
• This makes it easy to identify what version of Graylog is bundled, and reduces chance of confusing local and public builds

Release Process

The local build is for the native chipset only, but the release build is for both amd64 and arm64 architectures.

Configure buildx if not already done:

docker buildx ls
docker buildx create --name mybuilder
docker buildx use mybuilder

Build and push containers:

./release.sh 6.3.(BUILD_NUMBER)(BUILD_LETTER)

Update version number shown in README and commit this change.

Add release tag:

git tag 6.3.(BUILD_NUMBER)(BUILD_LETTER)
git push origin v6.3.x --tags