ERD Generator

Generate Entity Relationship Diagrams using the erd tool

Repository https://gitlab.com/ringingmountain/docker/erd-generator
CI Pipeline https://gitlab.com/ringingmountain/docker/erd-generator/pipelines
Documentation https://erd-generator.readthedocs.io/

pipeline docs

Usage

docker run \
  --user "$(id -u):$(id -g)" \
  -v "${PWD}/schemata":/schemata \
  -v "${PWD}/build":/build \
ringingmountain/erd-generator:latest \
  -i /docs/file.er \
  -o /build/file.svg

Quickstart Development Guide

Build Documentation

ci/docs.sh

Build Docker Image

./ci/build.sh [TAG]

Run Gitlab CI Jobs Locally

You will first need to install the Gitlab runner package and register a runner on your local machine.

gitlab-runner exec docker <job_name> --docker-services docker:dind --docker-privileged

Releasing a New Version

  1. Checkout master.
  2. Decide whether you are releasing a major, minor, or patch revision. For assistance in making this choice see the SemVer standard.
  3. Ensure an entry for the version exists in CHANGELOG.rst summarizing the changes you are releasing.
  4. Update the version in docs/conf.py
  5. Commit the changes, commenting that you are bumping the version.
  6. Tag the repo with the matching version.
  7. Push to the central remote and your fork.