Skip to content

Latest commit

 

History

History
118 lines (84 loc) · 2.76 KB

CONTRIBUTING.md

File metadata and controls

118 lines (84 loc) · 2.76 KB

Contributing to staticreg

To contribute you need

  • goreleaser: This is the tool we use to build and release staticreg, used by GNU Make to compile the project
  • Go: The Go compiler, used by goreleaser to build binaries (at least 1.21 so we can use Go Toolchains)
  • GNU Make: we use make to hide the details of running multiple commands to get builds done
  • Optional: Docker: to build container images and for running the local development dependencies

Start the local development environment with Docker Compose (includes Registry and PostgreSQL):

docker-compose up -d

This starts:

  • PostgreSQL database on port 5432
  • OCI Registry on port 5000

Alternatively, start a standalone registry and push an image to it:

docker run -d -p 5000:5000 --name registry registry:3
docker pull alpine
docker tag alpine:latest localhost:5000/alpine:latest
docker push localhost:5000/alpine:latest

Build staticreg

make deps
make

Set up the database (if using webhook/metrics features):

# Set database connection string
export STATICREG_DB_URL="postgresql://staticreg:password@localhost:5432/staticreg"

# Apply database schema
psql $STATICREG_DB_URL -f sql/event_schema.sql

Start staticreg

./_output/dist/staticreg serve

By default, staticreg will:

  • Serve the web UI on http://localhost:8093
  • Connect to the registry at localhost:5000
  • Store webhook events in PostgreSQL (if STATICREG_DB_URL is set)

Build (without releasing)

make clean
make

Testing Webhook Integration

To test the webhook integration locally:

  1. Ensure docker-compose services are running:

    docker-compose up -d

  2. Start staticreg:

    export STATICREG_DB_URL="postgresql://staticreg:password@localhost:5432/staticreg"
go run main.go serve

  3. Pull an image from the local registry to trigger webhook events:

    docker pull localhost:5000/alpine:latest

  4. Verify metrics are stored in the database:

    psql $STATICREG_DB_URL -c "SELECT pull_date, repo_name, tag, architecture, pull_count FROM container_pull_metrics ORDER BY pull_date DESC LIMIT 5;"

Release

Releasing is done via GitHub actions.

To release you need to:

  • Bump version in the VERSION file (this needs to be a semver numbers)
  • Commit the version file
  • Start the release process

Bump version file

git checkout master
echo "<new version>" > VERSION

Commit the version file

git commit -am "release: v$(cat VERSION)"
git push

Start the release process

make release