YANG Semantic Versioning
draft-ietf-netmod-yang-semver-01

Document Type Active Internet-Draft (netmod WG)
Last updated 2020-07-13
Replaces draft-verdt-netmod-yang-semver
Stream IETF
Intended RFC status (None)
Formats plain text xml pdf htmlized (tools) htmlized bibtex
Stream WG state WG Document
Document shepherd No shepherd assigned
IESG IESG state I-D Exists
Consensus Boilerplate Unknown
Telechat date
Responsible AD (None)
Send notices to (None)
Network Working Group                                          B. Claise
Internet-Draft                                            J. Clarke, Ed.
Updates: 8407 (if approved)                                    R. Rahman
Intended status: Standards Track                          R. Wilton, Ed.
Expires: January 14, 2021                            Cisco Systems, Inc.
                                                              B. Lengyel
                                                                Ericsson
                                                               J. Sterne
                                                                   Nokia
                                                              K. D'Souza
                                                                    AT&T
                                                           July 13, 2020

                        YANG Semantic Versioning
                    draft-ietf-netmod-yang-semver-01

Abstract

   This document specifies a scheme and guidelines 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.

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 January 14, 2021.

Copyright Notice

   Copyright (c) 2020 IETF Trust and the persons identified as the
   document authors.  All rights reserved.

   This document is subject to BCP 78 and the IETF Trust's Legal
   Provisions Relating to IETF Documents

Claise, et al.          Expires January 14, 2021                [Page 1]
Internet-Draft                 YANG Semver                     July 2020

   (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  . . . . . . . . . . .   8
     3.4.  Examples of the YANG Semver Label . . . . . . . . . . . .   9
       3.4.1.  Example Module Using YANG Semver  . . . . . . . . . .   9
       3.4.2.  Example of Package Using YANG Semver  . . . . . . . .  11
   4.  Import Module by Semantic Version . . . . . . . . . . . . . .  11
   5.  Guidelines for Using Semver During Module Development . . . .  11
     5.1.  Pre-release Version Precedence  . . . . . . . . . . . . .  13
     5.2.  YANG Semver in IETF Modules . . . . . . . . . . . . . . .  13
   6.  YANG Module . . . . . . . . . . . . . . . . . . . . . . . . .  13
   7.  Contributors  . . . . . . . . . . . . . . . . . . . . . . . .  15
   8.  Security Considerations . . . . . . . . . . . . . . . . . . .  16
   9.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .  16
   10. References  . . . . . . . . . . . . . . . . . . . . . . . . .  16
     10.1.  Normative References . . . . . . . . . . . . . . . . . .  16
     10.2.  Informative References . . . . . . . . . . . . . . . . .  17
   Appendix A.  Example IETF Module Development  . . . . . . . . . .  17
   Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . .  19

1.  Introduction

   [I-D.ietf-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.ietf-netmod-yang-module-versioning]
Show full document text