Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/gen_index_html.sh
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ for branch in $SORTED; do
echo " <td nowrap class=\"bg\"> <table> <tr> <td nowrap><a href=\"$branch/draft-yn-netmod-yang-xml-00.html\">html</a> / <a href=\"$branch/draft-yn-netmod-yang-xml-00.txt\">text</a> / <a href=\"$branch/draft-yn-netmod-yang-xml-00.xml\">xml</a></td> </tr> </table> </td>" >> index.html

if [ $branch = "main" ]; then
echo " <td nowrap class=\"bg\"><a href=\"https://author-tools.ietf.org/api/iddiff?doc_1=draft-yn-netmod-yang-xml&url_2=https://netmod-wg.github.io/yang-xml/main/draft-yn-netmod-yang-xml-00.txt\"><s>Diff with Datatracker</s></a> </td>" >> index.html
echo " <td nowrap class=\"bg\"><a href=\"https://author-tools.ietf.org/api/iddiff?doc_1=draft-yn-netmod-yang-xml&url_2=https://netmod-wg.github.io/yang-xml/main/draft-yn-netmod-yang-xml-00.txt.paged.txt\"><s>Diff with Datatracker</s></a> </td>" >> index.html
else
echo " <td nowrap class=\"bg\"> <a href=\"https://author-tools.ietf.org/api/iddiff?url_1=https://netmod-wg.github.io/yang-xml/$BASE/draft-yn-netmod-yang-xml-00.txt&url_2=https://netmod-wg.github.io/yang-xml/$branch/draft-yn-netmod-yang-xml-00.txt\">Diff with Main</a> </td>" >> index.html
fi
Expand Down
23 changes: 21 additions & 2 deletions .github/workflows/pull_request_updated.yml
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ jobs:
}
- name: Test summary line for changes
run: |
echo "${{env.SUMMARY_LINE}}" | grep -qF "0 flaws (~~), 3 warnings (==), 7 comments (--)" || {
echo "${{env.SUMMARY_LINE}}" | grep -qF "0 flaws (~~), 3 warnings (==), 3 comments (--)" || {
echo "::error::Idnits summary line different - examine why (fix workflow if needed)"
exit 1
}
Expand Down Expand Up @@ -123,10 +123,29 @@ jobs:
# fi
#

ensure_checklist_complete:
name: Ensure Checklist Complete
runs-on: ubuntu-latest
#needs: add_checklist
steps:
- name: Ensure Checklist Complete
uses: peter-evans/find-comment@v4
id: fc
with:
issue-number: ${{github.event.number}}
comment-author: 'github-actions[bot]'
body-includes: 'All of the following must be verified before merging to `main`.'
- run: |
if ${{ contains(steps.fc.outputs.comment-body, '[ ] Updated') }} ; then
echo "All checklist items must be selected."
exit 1
fi


update_github_pages:
name: Update the GitHub Page
runs-on: ubuntu-latest
needs: [xml2rfc, idnits_v2]
needs: xml2rfc
permissions:
pages: write
id-token: write
Expand Down
63 changes: 1 addition & 62 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,72 +17,11 @@ BCP 78, 79, the TLP, and the TLP rules regarding code components (e.g. being
subject to a Simplified BSD License) in Contributions.


# Production Process

All updates to the documents in this repository are made via pull requests (PRs)
submitted via the GitHub user interface. Anyone may submit a PR. See below for
more information about how PRs are reviewed and merged/closed.

As these documents are currently individual drafts (I-Ds), in the IETF sense, it
is not yet necessary to get consensus for changes made here.

Ultimately, this document will be submitted to the NETMOD WG for consideration
for adoption. At that time, WG consensus will be held for all of the updates
made up to that point.

However, until then, given the complexity of this effort, all updates (PRs) are
subject to a GitHub-enabled review process. Only the designated experts (i.e., the
`yang2-owners` team) and the PR-owner(s) participate in the review process.

A PR will be automatically-merged as soon as all of the following are true:
- The PR is up-to-date with the current `main` branch.
- All automated GitHub Workflow Actions pass (xml2rfc, idnits, etc.).
- There are at least three "approvals".
- There are no "request changes".
- All "conversations" resolved

Disclaimer: as no "experts" have been "designated" yet, the Editor has been
force-merging the PRs. This hasn't been an issue so far, as the changes to
date have been editorial. As soon as experts have been designated, the
ability for the Editor to force-merge will be removed.

In order to facilitate this process, it is expected that each PR will focus
on a single item, albeit taking it to completion. That is, the PR completely
updates all three documents, as needed. For instance, in addition to the
primary update, the PR must (as needed) update ancillarly sections:
- Summary of Changes from RFC 7950
- IANA Considerations
- Security Considerations
- Normative References
- Informative References
- Acknowledgements
- etc.

A checklist for such things is automatically attached to PRs when they
are opened to ensure these updates occur.

For complex issues, aspiring PR authors are encouraged to request
a "kickoff" discussion with the designated experts by creating a
"design" (a Markdown file in the `/designs` directory) and submitting
a PR to add just that file to the repository. Doing so triggers the
exact same merge-requirements listed above so, once the "design PR"
is merged, it is safe to proceed with the settled-upon approach.

Please note that, once these documents is adopted as a NETMOD WG document,
the same PR-process discussed above will continue with one modification:
instead of PRs being automatically-merged, they will instead block on
the Editor to ensure there is WG-consensus for the change.

Note that this is a necessary but largely perfunctorial gesture, as already
the update was approaved by the designated experts, leaving little room
for an objection to be raised.


# Build Artifacts

Each PR-update and PR-merge causes a GitHub Workflow to execute that generates and
publishes build artifacts (the draft compiled in its various formats) to be published to the
[Build artifacts for YANG2](https://netmod-wg.github.io/yang2)
[Build artifacts for YANG XML](https://netmod-wg.github.io/yang-xml)
page.


Expand Down
1 change: 1 addition & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ $(draft)-$(next_ver).xml: $(draft).xml
$(draft)-$(next_ver).txt: $(draft)-$(next_ver).xml
@echo "Making $@ from $<..."
$(xml2rfc) --v3 $< -o $@ --text --no-pagination
$(xml2rfc) --v3 $< -o $@.paged.txt --text

$(draft)-$(next_ver).html: $(draft)-$(next_ver).xml
@echo "Making $@ from $<..."
Expand Down
23 changes: 8 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,16 @@
# YANG 2.0
# YANG XML

This is the repository for the document `draft-yn-netmod-yang2`
(The YANG 2.0 Data Modeling Language).
This is the repository for the document `draft-yn-netmod-yang-xml`
(XML Encoding of YANG Data).

The initial initial goal is to make RFC 7950 not be XML or NETCONF specific,
thus setting a baseline for subsequent changes. This is accomplished by:
- removing the "XML Encoding Rules" sections.
- removing the "NETCONF &ltl;edit-config&gt; Operations" sections.
- removing the "NETCONF XML Encoding Rules" sections.
- removing the "Example Usage" sections.
- making remaining examples be both XML and JSON.

XML-specific text moves to `draft-yn-netmod-yang-xml` (XML Encoding
of Data Modeled with YANG).
The document mimics RFC 7951 (JSON Encoding of YANG Data), whilst
incoporating content from RFC 7951. The XML has comments indicating
where content was sourced.


## Build Artifacts and Diffs

https://netmod-wg.github.io/yang2
https://netmod-wg.github.io/yang-xml

GitHub workflow actions are used to automatically build, test, and
publish the three drafts, in the `html`, `txt`, and `xml` formats.
Expand All @@ -33,7 +26,7 @@ The webpage also provide links to:

All contributions are made using pull requests (PRs).

Please see the [contributing](https://github.com/netmod-wg/yang2/blob/main/CONTRIBUTING.md) page for details.
Please see the [contributing](https://github.com/netmod-wg/yang-xml/blob/main/CONTRIBUTING.md) page for details.


## Command Line Usage
Expand Down
Loading