Skip to content

Latest commit

 

History

History
51 lines (34 loc) · 1.61 KB

versioning_guidelines.md

File metadata and controls

51 lines (34 loc) · 1.61 KB
Raw

eProsima-CI VERSIONING GUIDELINES

Versioning in Github actions is very important, as many other projects will be affected from any change in this repository. These are the main guidelines to versioning this repository.

Versions

Mayor version

Any change can be done in a mayor version change.

Minor version

Minor version should preserve old API, as actions names, locations, arguments and arguments names. It can add new actions or optional arguments It can change external action versions.

Patch version

A patch version cannot add or change any API (action or argument name). It should only fix possible bugs.

Updating version

Steps to update the version of this repository to vX.Y.Z:

If updating the newest version

  1. Update VERSION file in main branch.
  2. Update versions.md documentation file in main branch.
  3. Create new branch X.Y.Z from main.
  4. Change to new branch release/X.Y.Z.
  5. Change every @<main> for @vX.Y.Z along the project.
  6. Set new tag in Github: https://github.com/eProsima/eProsima-CI as vX.Y.Z.
  7. Move vX.Y tag to refer vX.Y.Z tag.
  8. Move vX tag to refer vX.Y tag.

If updating a version that is not the last one

  1. Create new branch vX.Y.Z from base version vX.Y.Z'.
  2. Update VERSION file.
  3. Update versions.md documentation file.
  4. Change every @vX.Y.Z' for @vX.Y.Z along the project.
  5. Set new tag in Github: https://github.com/eProsima/eProsima-CI.
  6. Move vX.Y tag to refer vX.Y.Z tag.
  7. Move vX tag to refer vX.Y tag if there is not a newer Y.