Skip to content

Commit e63a581

Browse files
dcondreydcondrey
committed
migrate to martinthomson/i-d-template build system
1 parent ea0ef54 commit e63a581

File tree

13 files changed

+304
-154
lines changed

13 files changed

+304
-154
lines changed

‎.editorconfig‎

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,6 @@
11
root = true
22

3-
[*]
4-
indent_style = space
5-
indent_size = 2
6-
end_of_line = lf
3+
[*.{md,xml,org}]
74
charset = utf-8
8-
trim_trailing_whitespace = true
95
insert_final_newline = true
10-
11-
[*.xml]
12-
indent_size = 2
13-
14-
[*.cddl]
15-
indent_size = 2
16-
17-
[Makefile]
18-
indent_style = tab
6+
trim_trailing_whitespace = true

‎.github/workflows/archive.yml‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: "Archive Issues and Pull Requests"
2+
3+
on:
4+
schedule:
5+
- cron: '0 0 * * 0,2,4'
6+
repository_dispatch:
7+
types: [archive]
8+
workflow_dispatch:
9+
inputs:
10+
archive_full:
11+
description: 'Recreate the archive from scratch'
12+
default: false
13+
type: boolean
14+
15+
jobs:
16+
build:
17+
name: "Archive Issues and Pull Requests"
18+
runs-on: ubuntu-latest
19+
permissions:
20+
contents: write
21+
steps:
22+
- name: "Checkout"
23+
uses: actions/checkout@v5
24+
25+
# Note: No caching for this build!
26+
27+
- name: "Update Archive"
28+
uses: martinthomson/i-d-template@v1
29+
env:
30+
ARCHIVE_FULL: ${{ inputs.archive_full }}
31+
with:
32+
make: archive
33+
token: ${{ github.token }}
34+
35+
- name: "Update GitHub Pages"
36+
uses: martinthomson/i-d-template@v1
37+
with:
38+
make: gh-archive
39+
token: ${{ github.token }}
40+
41+
- name: "Save Archive"
42+
uses: actions/upload-artifact@v4
43+
with:
44+
name: archive
45+
path: archive.json

‎.github/workflows/build.yml‎

Lines changed: 0 additions & 48 deletions
This file was deleted.

‎.github/workflows/ghpages.yml‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
name: "Update Editor's Copy"
2+
3+
on:
4+
push:
5+
paths-ignore:
6+
- README.md
7+
- CONTRIBUTING.md
8+
- LICENSE.md
9+
- .gitignore
10+
pull_request:
11+
paths-ignore:
12+
- README.md
13+
- CONTRIBUTING.md
14+
- LICENSE.md
15+
- .gitignore
16+
17+
jobs:
18+
build:
19+
name: "Update Editor's Copy"
20+
runs-on: ubuntu-latest
21+
permissions:
22+
contents: write
23+
pull-requests: write
24+
steps:
25+
- name: "Checkout"
26+
uses: actions/checkout@v5
27+
28+
- name: "Setup"
29+
id: setup
30+
run: date -u "+date=%FT%T" >>"$GITHUB_OUTPUT"
31+
32+
- name: "Caching"
33+
uses: actions/cache@v4
34+
with:
35+
path: |
36+
.refcache
37+
.venv
38+
.gems
39+
node_modules
40+
.targets.mk
41+
key: i-d-${{ steps.setup.outputs.date }}
42+
restore-keys: i-d-
43+
44+
- name: "Build Drafts"
45+
id: build
46+
uses: martinthomson/i-d-template@v1
47+
with:
48+
token: ${{ github.token }}
49+
50+
- name: "Fix Lints"
51+
id: fix-lint
52+
if: always() && steps.build.outcome == 'failure'
53+
uses: martinthomson/i-d-template@v1
54+
with:
55+
make: fix-lint
56+
57+
- name: "Propose Linting Fixes"
58+
if: >
59+
always() &&
60+
steps.fix-lint.outcome != 'skipped' &&
61+
github.event.pull_request &&
62+
github.event.pull_request.head.repo.full_name == github.repository
63+
uses: parkerbxyz/suggest-changes@v3
64+
with:
65+
token: ${{ github.token }}
66+
67+
- name: "Update GitHub Pages"
68+
uses: martinthomson/i-d-template@v1
69+
if: ${{ github.event_name == 'push' }}
70+
with:
71+
make: gh-pages
72+
token: ${{ github.token }}
73+
74+
- name: "Archive Built Drafts"
75+
uses: actions/upload-artifact@v4
76+
with:
77+
name: drafts
78+
path: |
79+
draft-*.html
80+
draft-*.txt

‎.github/workflows/publish.yml‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
name: "Publish New Draft Version"
2+
3+
on:
4+
push:
5+
tags:
6+
- "draft-*"
7+
workflow_dispatch:
8+
inputs:
9+
email:
10+
description: "Submitter email"
11+
default: ""
12+
type: string
13+
14+
jobs:
15+
build:
16+
name: "Publish New Draft Version"
17+
runs-on: ubuntu-latest
18+
steps:
19+
- name: "Checkout"
20+
uses: actions/checkout@v5
21+
with:
22+
# Needed for tracing file history for replacement status
23+
fetch-depth: 0
24+
fetch-tags: true
25+
26+
# See https://github.com/actions/checkout/issues/290
27+
- name: "Get Tag Annotations"
28+
run: git fetch -f origin ${{ github.ref }}:${{ github.ref }}
29+
30+
- name: "Setup"
31+
id: setup
32+
run: date -u "+date=%FT%T" >>"$GITHUB_OUTPUT"
33+
34+
- name: "Caching"
35+
uses: actions/cache@v4
36+
with:
37+
path: |
38+
.refcache
39+
.venv
40+
.gems
41+
node_modules
42+
.targets.mk
43+
key: i-d-${{ steps.setup.outputs.date }}
44+
restore-keys: i-d-
45+
46+
- name: "Build Drafts"
47+
id: build
48+
uses: martinthomson/i-d-template@v1
49+
with:
50+
make: releases
51+
token: ${{ github.token }}
52+
53+
- name: "Upload to Datatracker"
54+
uses: martinthomson/i-d-template@v1
55+
with:
56+
make: upload
57+
env:
58+
UPLOAD_EMAIL: ${{ inputs.email }}
59+
GITHUB_STEP: upload
60+
61+
- name: "Archive Submitted Drafts"
62+
uses: actions/upload-artifact@v4
63+
if: always() && steps.build.outcome == 'success'
64+
with:
65+
name: published
66+
path: "versioned/draft-*-[0-9][0-9].*"

‎.github/workflows/update.yml‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: "Update Generated Files"
2+
# This rule is not run automatically.
3+
# It can be run manually to update all of the files that are part
4+
# of the template, specifically:
5+
# - README.md
6+
# - CONTRIBUTING.md
7+
# - .note.xml
8+
# - .github/CODEOWNERS
9+
# - Makefile
10+
#
11+
#
12+
# This might be useful if you have:
13+
# - added, removed, or renamed drafts (including after adoption)
14+
# - added, removed, or changed draft editors
15+
# - changed the title of drafts
16+
#
17+
# Note that this removes any customizations you have made to
18+
# the affected files.
19+
on: workflow_dispatch
20+
21+
jobs:
22+
build:
23+
name: "Update Files"
24+
runs-on: ubuntu-latest
25+
permissions:
26+
contents: write
27+
steps:
28+
- name: "Checkout"
29+
uses: actions/checkout@v5
30+
31+
- name: "Update Generated Files"
32+
uses: martinthomson/i-d-template@v1
33+
with:
34+
make: update-files
35+
token: ${{ github.token }}
36+
37+
- name: "Push Update"
38+
run: git push

‎.gitignore‎

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,24 @@
1-
# Generated outputs
2-
*.txt
31
*.html
42
*.pdf
5-
6-
# Editor files
7-
*~
3+
*.redxml
84
*.swp
9-
*.swo
10-
.vscode/
11-
.idea/
12-
13-
# Working notes
14-
issues.md
15-
16-
# OS files
17-
.DS_Store
18-
Thumbs.db
19-
20-
# Build artifacts
21-
lib/
22-
node_modules/
5+
*.txt
6+
*.upload
7+
*~
8+
.tags
9+
/*-[0-9][0-9].xml
10+
/.*.mk
11+
/.gems/
12+
/.refcache
13+
/.venv/
14+
/.vscode/
15+
/.idea/
16+
/node_modules/
17+
/versioned/
18+
Gemfile.lock
19+
archive.json
20+
package-lock.json
21+
report.xml
22+
!requirements.txt
23+
/lib
24+
*.DS_Store

‎CONTRIBUTING.md‎

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,17 @@
1-
# Contributing to Proof of Process Internet-Drafts
1+
# Contributing
22

3-
This repository contains Internet-Drafts submitted to the IETF. Contributions
4-
are welcome and should follow the [IETF contribution guidelines](https://www.ietf.org/about/participate/).
3+
This repository relates to activities in the Internet Engineering Task Force
4+
([IETF](https://www.ietf.org/)). All material in this repository is considered
5+
Contributions to the IETF Standards Process, as defined in the intellectual
6+
property policies of IETF currently designated as
7+
[BCP 78](https://www.rfc-editor.org/info/bcp78),
8+
[BCP 79](https://www.rfc-editor.org/info/bcp79) and the
9+
[IETF Trust Legal Provisions (TLP) Relating to IETF Documents](http://trustee.ietf.org/trust-legal-provisions.html).
510

6-
## How to Contribute
11+
Any edit, commit, pull request, issue, comment or other change made to this
12+
repository constitutes Contributions to the IETF Standards Process
13+
(https://www.ietf.org/).
714

8-
1. **Issues**: Open an issue to discuss proposed changes before submitting a pull request.
9-
2. **Pull Requests**: Submit changes against the `main` branch. All XML documents must validate with `xmllint`.
10-
3. **Style**: Follow RFC XML v2/v3 conventions. Use 2-space indentation for XML files.
11-
12-
## Note Well
13-
14-
All contributions are subject to the IETF's [Note Well](https://www.ietf.org/about/note-well/).
15-
Participants in the IETF Standards Process must be familiar with BCP 78, BCP 79,
16-
and the IETF Trust Legal Provisions.
17-
18-
## Contact
19-
20-
David Condrey — david@writerslogic.com
15+
You agree to comply with all applicable IETF policies and procedures, including,
16+
BCP 78, 79, the TLP, and the TLP rules regarding code components (e.g. being
17+
subject to a Simplified BSD License) in Contributions.

‎LICENSE.md‎

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,4 @@
11
# License
22

3-
This repository is subject to the provisions of [BCP 78](https://www.rfc-editor.org/info/bcp78)
4-
and the [IETF Trust's Legal Provisions Relating to IETF Documents](https://trustee.ietf.org/license-info).
5-
6-
The Internet-Drafts in this repository are submitted in full conformance
7-
with the provisions of BCP 78 and BCP 79.
8-
9-
Copyright (c) 2026 IETF Trust and the persons identified as the
10-
document authors. All rights reserved.
3+
See the
4+
[guidelines for contributions](https://github.com/writerslogic/draft-condrey-rats-pop/blob/main/CONTRIBUTING.md).

0 commit comments

Comments
 (0)