YANG Semantic Versioning
draft-verdt-netmod-yang-semver-01
Network Working Group B. Claise
Internet-Draft J. Clarke, Ed.
Intended status: Standards Track R. Rahman
Expires: April 13, 2020 R. Wilton, Ed.
Cisco Systems, Inc.
B. Lengyel
Ericsson
J. Sterne
Nokia
K. D'Souza
AT&T
October 11, 2019
YANG Semantic Versioning
draft-verdt-netmod-yang-semver-01
Abstract
This document specifies a scheme for applying a modified set of
semantic versioning rules to revisions of YANG modules.
Additionally, this document defines a revision label for this
modified semver scheme based on the specification in draft-verdt-
netmod-yang-module-versioning.
Status of This Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at https://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on April 13, 2020.
Copyright Notice
Copyright (c) 2019 IETF Trust and the persons identified as the
document authors. All rights reserved.
Claise, et al. Expires April 13, 2020 [Page 1]
Internet-Draft YANG Semver October 2019
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
2. Terminology and Conventions . . . . . . . . . . . . . . . . . 3
3. YANG Semantic Versioning . . . . . . . . . . . . . . . . . . 3
3.1. YANG Semantic Versioning Pattern . . . . . . . . . . . . 3
3.2. Semantic Versioning Scheme for YANG Artifacts . . . . . . 4
3.2.1. Examples for YANG semantic version numbers . . . . . 6
3.3. YANG Semantic Version Update Rules . . . . . . . . . . . 7
3.4. Examples of the YANG Semver Label . . . . . . . . . . . . 8
3.4.1. Example Module Using YANG Semver . . . . . . . . . . 8
3.4.2. Example of Package Using YANG Semver . . . . . . . . 10
4. Import Module by Semantic Version . . . . . . . . . . . . . . 10
5. YANG Module . . . . . . . . . . . . . . . . . . . . . . . . . 11
6. Contributors . . . . . . . . . . . . . . . . . . . . . . . . 12
7. Security Considerations . . . . . . . . . . . . . . . . . . . 13
8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 13
9. References . . . . . . . . . . . . . . . . . . . . . . . . . 13
9.1. Normative References . . . . . . . . . . . . . . . . . . 13
9.2. Informative References . . . . . . . . . . . . . . . . . 14
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 14
1. Introduction
[I-D.verdt-netmod-yang-module-versioning] puts forth a number of
concepts relating to modified rules for updating modules, a means to
signal when a new revision of a module has non-backwards-compatible
(NBC) changes compared to its previous revision, and a versioning
scheme that uses the revision history as a lineage for determining
from where a specific revision of a YANG module is derived.
Additionally, section 3.3 of
[I-D.verdt-netmod-yang-module-versioning] defines a revision label
which can be used as an overlay or alias to provide additional
context or an additional way to refer to a specific revision.
This document defines a labeling scheme that uses modified [semver]
Show full document text