Skip to content

Document versioning and release process #71

Description

@ricardozanini

Document the semantic versioning strategy, git tagging conventions, and release process for logic-platform images. This ensures consistent releases and clear communication of changes.

Acceptance Criteria

  • Document created at docs/RELEASE.md
  • Semantic versioning scheme documented (MAJOR.MINOR.PATCH)
    • MAJOR: Breaking changes (API, schema, configuration)
    • MINOR: New features, backward-compatible
    • PATCH: Bug fixes, backward-compatible
  • Git tag format specified: v<MAJOR>.<MINOR>.<PATCH> (e.g., v1.0.0)
  • Image tagging strategy documented:
    • latest - Most recent stable release
    • <version> - Exact version (e.g., 1.0.0)
    • <major>.<minor> - Latest patch for minor (e.g., 1.0)
  • Release checklist created with steps:
    1. Update CHANGELOG.md
    2. Run full test suite
    3. Create and push version tag
    4. Verify images published to quay.io
    5. Update deployment documentation with new version
  • Release trigger process documented (manual tag creation vs automation)
  • CONTRIBUTING.md updated with link to release process

Deliverables

File: docs/RELEASE.md

  • Versioning scheme
  • Tag naming conventions
  • Release checklist
  • Rollback procedure
  • Breaking change communication guidelines

File: CHANGELOG.md (template structure)

  • Unreleased section
  • Released versions with dates
  • Categories: Added, Changed, Deprecated, Removed, Fixed, Security

Release Trigger (Manual for v1.0)

# Developer creates and pushes tag
git tag -a v1.0.0 -m "Release v1.0.0 - Initial stable release"
git push origin v1.0.0

# GitHub Actions automatically:
# - Builds all images
# - Publishes to quay.io
# - Creates GitHub release with changelog

Dependencies

None

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions