Versioning concept

[philipwindecker]

Subject

Concept for Versioning and Branching of Project Guide

Section

nA

Description

• There must be a versioning concept for the Project Guide
• The main Guide shall cover all general and shared specific topics
• Project-specific branches may exist but must be agreed upon first by TSC
• main (= baseline) requires review process and higher rights (protected branch)
• main_standard (= baseline of standard) should be protected branch

Suggestion

• Describe process on adding project-specific branch
• Describe working on project-specific branch
• Describe working on base Project Guide
• Describe how to merge agreed changes from project branches
• Idea: Separate into Project Guide (current), released versions and Custom standard versions
• Idea 1: Create release versions of Project Guide with tags
• Idea 2: Create release versions of Project Guide as branches
• Keep all types of Project Guides (current, released and custom) in one repository, separated by tags or branches
• Label all work branches as "prerelease" = "-dev"
• Changes in a project may be confirmed by a project committee for merging
• Changes in the general Project Guide must be confirmed by a central committee
• Creating a version of the Project Guide must be confirmed by a central committee (typically the same as for changes on the general guide)
• Critical changes to the general Project Guide are either cherry-picked into relevant branches or branches rebase to a new branch/tag

URL	tbd
Page	tbd
Module	tbd

[philipwindecker]

The concept is documented here: https://asam-ev.github.io/asam-project-guide/asamprojectguide/project-guide/structure/02_versioning_concept.html

[philipwindecker]

The approach:

• main branch
  • Contains the tagged versions
  • Only tagged versions are displayed!
  • Tags must be v.. and are displayed as x.y.z
  • The latest tag is labeled "latest" in the url (fixed url pointing to the latest release)
  • Is source for dev branch
• dev branch
  • Created from main
  • Contains the current state of development
  • Always is a pre-release with "dev" and has no version number
  • Only exists when non-official changes exist (i.e. during development)
• Hotfixes may be implemented directly on main
• TBD: Create branch for each major/minor version so Hotfixes can be developed after the fact
• Working on the Project Guide only shows the latest release

[philipwindecker]

Concept updated, needs review now.