Skip to content

RELEASING.md

Latest commit

 

History

History
36 lines (24 loc) · 1.78 KB

RELEASING.md

File metadata and controls

36 lines (24 loc) · 1.78 KB

Releases and versioning

EdgePlug is a multi-component repository. Version tags and release notes may refer to one or more of:

  • marketplace/ — Go API and Docker image
  • ui/ — npm package @edgeplug/ui
  • runtime/ — embedded firmware runtime
  • models/ — ML training and conversion tooling
  • marketplace/desktop/ — Electron desktop client

Versioning policy

  • Use semantic versioning per artifact where it is published (for example v1.2.0 for the API image, separate tags for UI package bumps if published to a registry).
  • Document in each GitHub Release which components changed and any migration steps.

Changelog

  • Prefer meaningful commit messages; optionally adopt Conventional Commits to drive automated changelog generation.
  • For user-visible API or manifest (manifest.proto) changes, call them out explicitly in release notes.

Supply chain

  • Go: run govulncheck ./... from marketplace/ before tagging (also enforced in CI).
  • Container images: rebuild from pinned base images; SBOM generation is configured in .github/workflows/marketplace.yml for pushes to main and for tags.
  • JavaScript: lockfiles under ui/ and marketplace/desktop/; Dependabot updates are configured in .github/dependabot.yml.
  • Python: lockfile models/uv.lock; sync with uv lock after changing models/pyproject.toml.

GitHub settings (repository administrators)

Configure in Settings → Branches (or org rulesets):

  • Require pull request reviews before merging to main.
  • Require status checks to pass (UI, Marketplace, Runtime, Models, Desktop as applicable).
  • Enable secret scanning and push protection where available.

These items cannot be committed as files; they are enforced on the hosting platform.