How enercity/zeebe-simple-monitor-patches works
Project type and purpose
• This is not a typical runtime application but a Git-based patch‐and‐release management repo for “zeebe-simple-monitor.”
• Its purpose is to maintain a fork of upstream code, apply patches in isolated feature branches, combine them on release branches, and automate builds/deploys via GitHub Actions.
File structure
• Top level
• .github/ – GitHub Actions workflows and Dependabot config
– workflows/build.yml
– workflows/deploy.yml
• README.md – describes branch strategy, patch workflow, and contributor instructions
• .gitignore
• No src/ or code directories, since code lives upstream; this repo orchestrates patch branches and CI/CD.
README for additional insights
• Branch strategy: main (fork of upstream), release/upstream/vX.Y.Z, feature/*, release/vX.Y.Z-with-patches
• Workflow steps: sync from upstream → create release branches → apply feature branches → build & release
Diagramming the architecture
a. Main components
1. Upstream Zeebe‐Simple‐Monitor GitHub repo
2. Local developer clones (feature dev environment)
3. This forked repo on GitHub (branches: main, release, feature)
4. GitHub Actions workflows (build.yml, deploy.yml)
5. Dependabot (dependency updates)
6. Release artifacts (build outputs, Docker images, JARs)
b. Relationships & interactions
• Developers pull upstream changes into local, push to this fork’s main
• Release branches created from main → feature branches fork off them
• Feature branches merged into release/vX.Y.Z-with-patches
• Push to any branch triggers build.yml; tags or merges to release/* trigger deploy.yml
• Dependabot periodically creates PRs to update deps in fork
c. Architectural patterns
• Git branching model (similar to GitFlow but with explicit upstream sync)
• CI/CD pipeline using GitHub Actions
• Separation of concerns:
• “main” holds pure upstream code
• “release/upstream” tracks upstream tags
• “feature” branches for patches
• “release/v…-with-patches” for combined output
d. Key technologies
• Git & GitHub (forks, branches, tags, PRs)
• GitHub Actions (YAML workflows in .github/workflows)
• Dependabot for dependency management
Elements
• Upstream → Forked main (sync)
• Developer Local ↔ Forked feature branches (pull/push)
• Forked branches → CI (on push) → Artifacts
• CI → Deploy job (on release tags)
• Dependabot → Forked repo (auto-PRs)
• Blue for Git repos & branches
• Green for CI/CD workflows
• Orange for external services