Skip to content

Latest commit

 

History

History
45 lines (30 loc) · 1.69 KB

VENDORING.md

File metadata and controls

45 lines (30 loc) · 1.69 KB
Raw

Vendoring policies

This document outlines recommended vendoring policies for N3N projects.

Vendoring using tags

Commit ID based vendoring provides little/no information about the updates vendored. To fix this, vendors will now require that repositories use annotated tags along with commit ids to snapshot commits. Annotated tags by themselves are not sufficient, since the same tag can be force updated to reference different commits.

Each tag should:

  • Follow Semantic Versioning rules (refer to section on "Semantic Versioning")
  • Have a corresponding entry in the change tracking document.

Each repo should:

  • Have a change tracking document between tags/releases. Ex: CHANGELOG.md, github releases file.

The goal here is for consuming repos to be able to use the tag version and changelog updates to determine whether the vendoring will cause any breaking or backward incompatible changes. This also means that repos can specify having dependency on a package of a specific version or greater up to the next major release, without encountering breaking changes.

Semantic Versioning

Annotated version tags should follow Semantic Versioning policies:

"Given a version number MAJOR.MINOR.PATCH, increment the:

  1. MAJOR version when you make incompatible API changes,
  2. MINOR version when you add functionality in a backwards-compatible manner, and
  3. PATCH version when you make backwards-compatible bug fixes.

Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format."

Vendoring cadence

In order to avoid huge vendoring changes, it is recommended to have a regular cadence for vendoring updates. e.g. monthly.