[netmod] Re: Call for volunteers for CI/CD YANG Integration in martinthomson/internet-draft-template
Hi all,
Thanks for the interest and sharing all these inputs.
FYI, we had a kick-off meeting yesterday. The introduction slides (including
participants, sketch, first agreed points) can be found here:
https://github.com/IETF-OPS-AD/misc/blob/main/cicd-yang-template.pdf.
This work will be hosted here:
https://github.com/IETF-OPS-AD/I-D-with-yang-template. Please use that link to
report issues, etc.
Cheers,
Med
De : Rob Wilton (rwilton)
Envoyé : mardi 22 avril 2025 16:38
À : Florian Kauer ; BOUCADAIR Mohamed INNOV/NET
; netmod@ietf.org
Cc : Italo Busi
Objet : Re: [netmod] Re: Call for volunteers for CI/CD YANG Integration in
martinthomson/internet-draft-template
Hi Med,
Another example could be my repo on YANG Push Lite:
https://github.com/rgwilton/draft-yp-observability/
I have used Martin's repo as a template, but I have a separate build file
(https://github.com/rgwilton/draft-yp-observability/blob/main/build.mill)
(using Mill rather than Make) to handle the YANG aspects, but still use Make
for the underlying conversion from Markdown to draft + HTML.
The readme file associated with the repo
https://github.com/rgwilton/draft-yp-observability/blob/main/README.md gives
some instructions. It is still somewhat a work in progress, but currently will
(at least on Mac OS):
* Download RFCs & drafts revisions, download/install python venv & pyang,
extract YANG files, fixed some mistakes, compiler and validates sets of modules
together (using pyang, and also YANG lint, if installed on the path), builds
various YANG trees and generates snippets from them.
* The generated assets can then be referenced into a markdown file.
* If you ask mill to watch local files ("./mill --watch all"), then it can
automatically recompile locally if you change the build file, or any of the
local YANG files, or the markdown source file, so you can keep a copy of the
generated html open next to you and it will auto update YANG files, draft text,
and tree diagrams whenever you save.
It also has a command that you can run to check if there are newer versions of
any referenced drafts, e.g.:
rwilton@RWILTON-M-4RJ2 draft-yp-observability % ./mill checkDraftLatest
[1/1] checkDraftLatest
[1] Warning: draft-ietf-netconf-yang-notifications-versioning latest revsion is
8, using 7
[1] Warning: draft-ietf-netconf-yang-library-augmentedby latest revsion is 3,
using 2
[1/1] == checkDraftLatest
== 8s
The actual underlying build rules are currently in the repo here:
https://github.com/rgwilton/draft-yp-observability/blob/main/util_ietf.mill
But when I get the time, my plan to package the build rules as a versioned Jar
file on Maven, which can then be trivially imported by the draft specific build
file.
I haven't spent any time to hook this into github actions - but that is
something else that I would probably also do.
Kind regards,
Rob
From: Florian Kauer
mailto:florian.ka...@linutronix.de>>
Date: Tuesday, 15 April 2025 at 03:54
To: mohamed.boucad...@orange.com<mailto:mohamed.boucad...@orange.com>
mailto:mohamed.boucad...@orange.com>>,
netmod@ietf.org<mailto:netmod@ietf.org>
mailto:netmod@ietf.org>>
Cc: Italo Busi mailto:italo.b...@huawei.com>>
Subject: [netmod] Re: Call for volunteers for CI/CD YANG Integration in
martinthomson/internet-draft-template
Hi all,
On 4/11/25 15:37,
mohamed.boucad...@orange.com<mailto:mohamed.boucad...@orange.com> wrote:
> If you are interested to help with this, please drop us an email. A first
> meeting is schedule April 28.
I would also be interested in this discussion.
We are currently approaching the CI/CD YANG topic in the following way
https://github.com/Linutronix/yang-validation
It was used to work on draft-ietf-netmod-intf-ext-yang-16 and IEEE 802.1Qcw
Greetings,
Florian
___
netmod mailing list -- netmod@ietf.org<mailto:netmod@ietf.org>
To unsubscribe send an email to
netmod-le...@ietf.org<mailto:netmod-le...@ietf.org>
Ce message et ses pieces jointes peuvent contenir des informations
confidentielles ou privilegiees et ne doivent donc
pas etre diffuses, exploites ou copies sans autorisation. Si vous avez recu ce
message par erreur, veuillez le signaler
a l'expediteur et le detruire ainsi que les pieces jointes. Les messages
electroniques etant susceptibles d'alteration,
Orange decline toute responsabilite si ce message a ete altere, deforme ou
falsifie. Merci.
This message and its attachments may contain confidential or privileged
information that may be protected by law;
they should not be distributed, used or copied without authorisation.
If you have received this email in error, please notify the sender and delete
this messa
[netmod] Re: Call for volunteers for CI/CD YANG Integration in martinthomson/internet-draft-template
Hi Med, Another example could be my repo on YANG Push Lite: https://github.com/rgwilton/draft-yp-observability/ I have used Martin’s repo as a template, but I have a separate build file (https://github.com/rgwilton/draft-yp-observability/blob/main/build.mill) (using Mill rather than Make) to handle the YANG aspects, but still use Make for the underlying conversion from Markdown to draft + HTML. The readme file associated with the repo https://github.com/rgwilton/draft-yp-observability/blob/main/README.md gives some instructions. It is still somewhat a work in progress, but currently will (at least on Mac OS): * Download RFCs & drafts revisions, download/install python venv & pyang, extract YANG files, fixed some mistakes, compiler and validates sets of modules together (using pyang, and also YANG lint, if installed on the path), builds various YANG trees and generates snippets from them. * The generated assets can then be referenced into a markdown file. * If you ask mill to watch local files (“./mill --watch all”), then it can automatically recompile locally if you change the build file, or any of the local YANG files, or the markdown source file, so you can keep a copy of the generated html open next to you and it will auto update YANG files, draft text, and tree diagrams whenever you save. It also has a command that you can run to check if there are newer versions of any referenced drafts, e.g.: rwilton@RWILTON-M-4RJ2 draft-yp-observability % ./mill checkDraftLatest [1/1] checkDraftLatest [1] Warning: draft-ietf-netconf-yang-notifications-versioning latest revsion is 8, using 7 [1] Warning: draft-ietf-netconf-yang-library-augmentedby latest revsion is 3, using 2 [1/1] == checkDraftLatest == 8s The actual underlying build rules are currently in the repo here: https://github.com/rgwilton/draft-yp-observability/blob/main/util_ietf.mill But when I get the time, my plan to package the build rules as a versioned Jar file on Maven, which can then be trivially imported by the draft specific build file. I haven’t spent any time to hook this into github actions – but that is something else that I would probably also do. Kind regards, Rob From: Florian Kauer Date: Tuesday, 15 April 2025 at 03:54 To: mohamed.boucad...@orange.com , netmod@ietf.org Cc: Italo Busi Subject: [netmod] Re: Call for volunteers for CI/CD YANG Integration in martinthomson/internet-draft-template Hi all, On 4/11/25 15:37, mohamed.boucad...@orange.com wrote: > If you are interested to help with this, please drop us an email. A first > meeting is schedule April 28. I would also be interested in this discussion. We are currently approaching the CI/CD YANG topic in the following way https://github.com/Linutronix/yang-validation It was used to work on draft-ietf-netmod-intf-ext-yang-16 and IEEE 802.1Qcw Greetings, Florian ___ netmod mailing list -- netmod@ietf.org To unsubscribe send an email to netmod-le...@ietf.org ___ netmod mailing list -- netmod@ietf.org To unsubscribe send an email to netmod-le...@ietf.org
[netmod] Re: Call for volunteers for CI/CD YANG Integration in martinthomson/internet-draft-template
Hi all, On 4/11/25 15:37, mohamed.boucad...@orange.com wrote: > If you are interested to help with this, please drop us an email. A first > meeting is schedule April 28. I would also be interested in this discussion. We are currently approaching the CI/CD YANG topic in the following way https://github.com/Linutronix/yang-validation It was used to work on draft-ietf-netmod-intf-ext-yang-16 and IEEE 802.1Qcw Greetings, Florian ___ netmod mailing list -- netmod@ietf.org To unsubscribe send an email to netmod-le...@ietf.org
[netmod] Re: Call for volunteers for CI/CD YANG Integration in martinthomson/internet-draft-template
Hi Michael, > yes. I'm saying: can we please consider self-hosting this. > Thanks. I prefer when things are explicit :-) I added a new section "IETF-hosted Repository" to cover this point (https://datatracker.ietf.org/doc/html/draft-boucadair-veloce-yang-04#name-ietf-hosted-repository). The starting point for discussion is follows: It is RECOMMENDED that IETF self-hosted repositories are used. Integration using third-party hosted repositories MAY be used for experimentation purposes. DISCUSSION: Include a recommendation about the hosting. IANA or some IETF gitlab are examples of self-hosting. Example of third- part hosted facility is GitHub. We can iterate on that. Cheers, Med > -Message d'origine- > De : Michael Richardson > Envoyé : samedi 12 avril 2025 23:00 > À : BOUCADAIR Mohamed INNOV/NET > Cc : netmod@ietf.org; Italo Busi > Objet : Re: [netmod] Call for volunteers for CI/CD YANG > Integration in martinthomson/internet-draft-template > > > mohamed.boucad...@orange.com wrote: > >> I augment (pun intended) the MT Makefile with a bunch of > stuff. > >> > >> } * A new repository MUST be created by the WG Chairs > following > >> the > >> } procedure in Section 3.2 of [RFC8874] to maintain > the YANG > >> Module, > >> } with the appropriate CI/CD YANG validation in place. > >> > >> gosh I wish we were doing this with some gitlab.ietf.org. > > > [Med] That’s not excluded by the text you quoted. That > section 3.2 from > > 8874 is generic enough to cover any location we decide to > maintain the > > files. > > yes. I'm saying: can we please consider self-hosting this. > > >> It should include a commitid. > > -- > Michael Richardson. o O ( IPv6 IøT > consulting ) >Sandelman Software Works Inc, Ottawa and Worldwide > > > Ce message et ses pieces jointes peuvent contenir des informations confidentielles ou privilegiees et ne doivent donc pas etre diffuses, exploites ou copies sans autorisation. Si vous avez recu ce message par erreur, veuillez le signaler a l'expediteur et le detruire ainsi que les pieces jointes. Les messages electroniques etant susceptibles d'alteration, Orange decline toute responsabilite si ce message a ete altere, deforme ou falsifie. Merci. This message and its attachments may contain confidential or privileged information that may be protected by law; they should not be distributed, used or copied without authorisation. If you have received this email in error, please notify the sender and delete this message and its attachments. As emails may be altered, Orange is not liable for messages that have been modified, changed or falsified. Thank you. ___ netmod mailing list -- netmod@ietf.org To unsubscribe send an email to netmod-le...@ietf.org
[netmod] Re: Call for volunteers for CI/CD YANG Integration in martinthomson/internet-draft-template
mohamed.boucad...@orange.com wrote: >> I augment (pun intended) the MT Makefile with a bunch of stuff. >> >> } * A new repository MUST be created by the WG Chairs following >> the >> } procedure in Section 3.2 of [RFC8874] to maintain the YANG >> Module, >> } with the appropriate CI/CD YANG validation in place. >> >> gosh I wish we were doing this with some gitlab.ietf.org. > [Med] That’s not excluded by the text you quoted. That section 3.2 from > 8874 is generic enough to cover any location we decide to maintain the > files. yes. I'm saying: can we please consider self-hosting this. >> It should include a commitid. -- Michael Richardson. o O ( IPv6 IøT consulting ) Sandelman Software Works Inc, Ottawa and Worldwide signature.asc Description: PGP signature ___ netmod mailing list -- netmod@ietf.org To unsubscribe send an email to netmod-le...@ietf.org
[netmod] Re: Call for volunteers for CI/CD YANG Integration in martinthomson/internet-draft-template
Re-, Please see inline. Cheers, Med > -Message d'origine- > De : Michael Richardson > Envoyé : vendredi 11 avril 2025 18:54 > À : BOUCADAIR Mohamed INNOV/NET > Cc : netmod@ietf.org; Italo Busi > Objet : Re: [netmod] Call for volunteers for CI/CD YANG > Integration in martinthomson/internet-draft-template > > > mohamed.boucad...@orange.com wrote: > > Some of us are using "ways" to integrate YANG CI/CD > validation with > > that of an I-D. For example, see the approach I'm following: > > Yes. > https://github.com/anima-wg/voucher/blob/main/Makefile [Med] Thanks for sharing. > > > However, when discussing with Italo/Prasenjit/Qin, we think > that this > > can be optimized by integrating YANG validation directly in > the I-D > > template maintained by M. Thomson > > (https://github.com/martinthomson/internet-draft-template) > or create a > > fork that we can maintain for YANG authors. This is also > need to > > experiment with the approach in > > https://datatracker.ietf.org/doc/draft-boucadair-veloce- > yang/. > > I augment (pun intended) the MT Makefile with a bunch of stuff. > > } * A new repository MUST be created by the WG Chairs following > the > } procedure in Section 3.2 of [RFC8874] to maintain the YANG > Module, > } with the appropriate CI/CD YANG validation in place. > > gosh I wish we were doing this with some gitlab.ietf.org. [Med] That’s not excluded by the text you quoted. That section 3.2 from 8874 is generic enough to cover any location we decide to maintain the files. > > } * The YANG module MUST NOT be inserted in the document; > instead a > } link to the above repository MUST be included. > > okay. I'm all for this part! [Med] Great! > > It should include a commitid. [Med] Agree. This is intended to be covered by: - A release tagging mechanism should be defined to track the intermediate versions referenced by WG I-Ds and by the RFC, once published. > Perhaps this part can be automated; at least we could > "git rev-parse HEAD >yang-module-include.txt" > or something like that in the Makefile, and then tell kramdown to > include that file to get the right link. > [Med] Seems like to good path to explore. > -- > Michael Richardson. o O ( IPv6 IøT > consulting ) >Sandelman Software Works Inc, Ottawa and Worldwide > > > Ce message et ses pieces jointes peuvent contenir des informations confidentielles ou privilegiees et ne doivent donc pas etre diffuses, exploites ou copies sans autorisation. Si vous avez recu ce message par erreur, veuillez le signaler a l'expediteur et le detruire ainsi que les pieces jointes. Les messages electroniques etant susceptibles d'alteration, Orange decline toute responsabilite si ce message a ete altere, deforme ou falsifie. Merci. This message and its attachments may contain confidential or privileged information that may be protected by law; they should not be distributed, used or copied without authorisation. If you have received this email in error, please notify the sender and delete this message and its attachments. As emails may be altered, Orange is not liable for messages that have been modified, changed or falsified. Thank you. ___ netmod mailing list -- netmod@ietf.org To unsubscribe send an email to netmod-le...@ietf.org
[netmod] Re: Call for volunteers for CI/CD YANG Integration in martinthomson/internet-draft-template
mohamed.boucad...@orange.com wrote: > Some of us are using "ways" to integrate YANG CI/CD validation with > that of an I-D. For example, see the approach I'm following: Yes. https://github.com/anima-wg/voucher/blob/main/Makefile > However, when discussing with Italo/Prasenjit/Qin, we think that this > can be optimized by integrating YANG validation directly in the I-D > template maintained by M. Thomson > (https://github.com/martinthomson/internet-draft-template) or create a > fork that we can maintain for YANG authors. This is also need to > experiment with the approach in > https://datatracker.ietf.org/doc/draft-boucadair-veloce-yang/. I augment (pun intended) the MT Makefile with a bunch of stuff. } * A new repository MUST be created by the WG Chairs following the } procedure in Section 3.2 of [RFC8874] to maintain the YANG Module, } with the appropriate CI/CD YANG validation in place. gosh I wish we were doing this with some gitlab.ietf.org. } * The YANG module MUST NOT be inserted in the document; instead a } link to the above repository MUST be included. okay. I'm all for this part! It should include a commitid. Perhaps this part can be automated; at least we could "git rev-parse HEAD >yang-module-include.txt" or something like that in the Makefile, and then tell kramdown to include that file to get the right link. -- Michael Richardson. o O ( IPv6 IøT consulting ) Sandelman Software Works Inc, Ottawa and Worldwide signature.asc Description: PGP signature ___ netmod mailing list -- netmod@ietf.org To unsubscribe send an email to netmod-le...@ietf.org
[netmod] Re: Call for volunteers for CI/CD YANG Integration in martinthomson/internet-draft-template
On Fri, Apr 11, 2025 at 1:38 PM wrote: > > Hi all, > > > > Some of us are using “ways” to integrate YANG CI/CD validation with that of > an I-D. For example, see the approach I’m following: > > https://github.com/netmod-wg/schedule-yang > https://github.com/boucadair/secure-tacacs-yang > https://github.com/boucadair/attachment-circuit-model > > > > However, when discussing with Italo/Prasenjit/Qin, we think that this can be > optimized by integrating YANG validation directly in the I-D template > maintained by M. Thomson > (https://github.com/martinthomson/internet-draft-template) or create a fork > that we can maintain for YANG authors. This is also need to experiment with > the approach in https://datatracker.ietf.org/doc/draft-boucadair-veloce-yang/. > > > > If you are interested to help with this, please drop us an email. A first > meeting is schedule April 28. I am interested in helping with this. -- Per ___ netmod mailing list -- netmod@ietf.org To unsubscribe send an email to netmod-le...@ietf.org
