Google Sign-In Required

Use your company Google account to access the BetterFleet private content.

Back to private home

BetterFleet Support Private
Skip to content
BetterFleet Dev Wiki
Release Plan: Release Notes Automation
Initializing search
    bf-dev
    • Home
    • Product Capabilities
    • Process
    • Current Work
    • System Design
    • Software Reference
    • Operations
    bf-dev
    • Home
      • Overview
      • Manage
      • Overview
      • Product Engineering Workflow
      • Product Engineering Delivery
      • Product Engineering Workflow in Linear
        • GitLab Feature Flags
        • In-App Docs Authoring
        • Release Notes
      • Templates
      • Publishing
      • Workflow Companions
      • Overview
      • Active Artifacts
      • Backlog Artifacts
      • Archived Artifacts
      • Overview
      • Microgrid
      • OSCP
        • Challenge
        • Specification
        • Spec
        • Architecture
        • Overview
        • Script Runtime Model
        • Compose Profiles and Modes
        • Repo Topology
        • CI and Release Integration
        • Overview
        • Internal Application Diagrams
          • Overview
          • Web Model
          • Core Model
        • Service Interaction Flows
        • Data and State
          • Index
          • bf-manage-web
          • bf-manage-core
          • bf-manage-connect
          • bf-manage-sitepwrmon
          • bf-manage-incidents
          • bf-telematics
          • bf-depot-sim
          • bf-manage-roaming
          • bf-support-microsite
          • bf-digital-twin
          • bf-schedule-creator
        • Overview
        • Internal Application Diagrams
        • Migration and Flags
        • Simulation Request Lifecycle
          • Index
          • bf-bnl-ui
          • bf-bnl-settings
          • bf-bnl-schedule-analysis-compute
          • bf-route-modelling
          • bf-schedule-creator
          • bf-digital-twin
        • Overview
        • Secrets and Env Strategy
        • Vendors and Local Dependencies
        • ADRs
        • Service Matrix
        • Cloud Dependencies
        • Ports and URLs
      • Onboarding
      • Daily Operations Runbook
        • Overview
        • Staging Hotfix Release
        • Production Hotfix Release
        • Terraform Plan Dry Runs
      • Troubleshooting
      • Testing Guide
    • Summary
    • Included Scope
    • Release Notes
    • Rollout Controls
    • Validation

    Release Plan: Release Notes Automation¶

    Summary¶

    • Automate weekly packaging of Vemo Manage release notes by promoting unreleased markdown artifacts into dated files under docs/release-notes/releases/ and resetting the base templates for the next cycle.
    • Scope is internal release-note operations; no direct customer-facing product change.

    Included Scope¶

    • GitLab CI job 02 publish:release in bf-release/Changes.gitlab-ci.yml running in stage Staging(changes).
    • On each run, clones projects listed in PROJECTS (default evenergi/vemo/vemo-manage), computes code (YYYY.WW) and date from SCHEDULE (default "next tuesday"), and processes base artifacts docs/release-notes/unreleased(.internal).md.
    • Generates new release notes in docs/release-notes/releases/<YYYY.WW>.md (and .internal.md for variants), preserves existing files by refusing to overwrite, and commits/pushes branch release-notes-<YYYY.WW> with message docs(release): publish release notes for <code> [skip ci].
    • Resets the base unreleased artifacts to a default template with empty Added/Changed/Fixed sections after promotion.

    Release Notes¶

    • Expected outputs per run: docs/release-notes/releases/<YYYY.WW>.md and docs/release-notes/releases/<YYYY.WW>.internal.md containing front matter (title = <YYYY.WW>, release_date = computed date) plus the prior unreleased content body.
    • Base artifacts docs/release-notes/unreleased.md and docs/release-notes/unreleased.internal.md are rewritten to the default stub template ready for the next cycle.

    Rollout Controls¶

    • Scheduled runs require PUBLISH_RELEASE=true and the CI schedule; manual invocation is allowed via the same job when explicit pushes are needed.
    • Branch output is isolated to release-notes-<YYYY.WW>; target projects must have GITLAB_TOKEN push access.

    Validation¶

    • GitLab pipeline run has been executed to verify cloning, release-note generation, template reset, and push to the target branch.
    Made with Material for MkDocs