YANG module file name convention

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 5 December 2026.¶

Copyright Notice

Copyright (c) 2026 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 (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 Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License.¶

Table of Contents

1. Introduction

This document defines the YANG module file name convention. It extends the current convention defined in [RFC6020], [RFC7950], and [RFC9907], which uses revision-date, with the YANG semantic version extension defined in [I-D.ietf-netmod-yang-semver].¶

2. YANG Module File Names

This section updates Section 5.2 of [RFC7950], Section 5.2 of [RFC6020], and Section 3.2 of [RFC9907].¶

If a revision has an associated YANG semantic version (ysv:version) then a YANG file SHOULD be created that uses the YANG semantic version in the file name. Additionally, YANG files with or without the revision-date MAY be created. The name of the files SHOULD be of the form:¶

    module-or-submodule-name ['@' (ysv:version) / (revision-date)]
        ( '.yang' / '.yin' )

E.g., acme‑router‑module@2.0.3.yang, acme‑router‑module@2024‑05‑15.yang, or acme‑router‑module.yang.¶

Due to limitations of tooling, requirements of interoperability with legacy systems, and deployed system limitations, it might be difficult or impractical to use the file name convention defined in this document. In such cases it is acceptable to not use the YANG module file name convention.¶

The ysv:version in the file name MUST match the ysv:version in the most recent revision of the YANG module.¶

Even though the ysv:version and the file name must match, the authorative source for the ysv:version is the contents in the YANG module, not the file name.¶

Note that several files might be created as a consequence of using ysv:version or revision-date. For instance a YANG module without ysv:version can be defined in either "module.yang", "module@2020-02-20.yang", or both. A YANG module with ysv:version can be represented by "module@1.0.0.yang", "module@2026-06-02.yang", "module.yang". The contents of the YANG modules for the same revision MUST be identical byte-for-byte.¶

In short, the YANG semantic version file name scheme is RECOMMENDED, as its use will convey compatibility status at a glance without the need to read the module. If a system or tooling can't handle the YANG module file name convention, it is acceptable to not support or use the convention defined in this document.¶

        module ietf-foo {
          namespace "urn:ietf:params:xml:ns:yang:ietf-foo";
          prefix "foo";
          organization "...";
          contact "...";
          description "...";
          revision 2026-06-02 {
            ysv:version 1.0.0;
            description "Latest revision";
            reference "RFC FFFF: Foo Protocol";
          }
          // ... more statements
        }

    example-module@2.3.1_non_compatible+build2237refM443ss.yang

    2.0.1-draft-superman-super-stuff-03

    2.0.1-draft-batman-cool-addition-07   (a competing draft)

5. Security Considerations

There are no security considerations for this document.¶

Author's Address