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: 2 additions & 0 deletions .bundle/config
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
BUNDLE_PATH: "vendor/bundle"
38 changes: 26 additions & 12 deletions .github/workflows/build-rfc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,23 +15,37 @@ jobs:
- uses: actions/checkout@v4
- uses: actions/cache@v4
with:
path: |
$HOME/.local/share/gem
.refcache
key: webdav-push.mkd

- name: Install packages
run: >
sudo apt-get install --no-install-recommends -y golang-go &&
sudo gem install kramdown-rfc &&
sudo pip3 install svgcheck xml2rfc --break-system-packages &&
go install github.com/blampe/goat/cmd/goat@latest && echo ~/go/bin >> $GITHUB_PATH
path: .refcache
key: kramdown-refcache

- name: Set up Python
uses: actions/setup-python@v6
with:
python-version: '3.x'
cache: 'pip'

- name: Set up Ruby
uses: ruby/setup-ruby@v1
with:
bundler-cache: true
ruby-version: '4.0'

- name: Set up Node.js
uses: actions/setup-node@v6
with:
node-version: 'latest'
cache: 'npm'

- name: Install dependencies
run: |
pip install -r requirements.txt
npm ci && echo "$GITHUB_WORKSPACE/node_modules/.bin" >> "$GITHUB_PATH"

- name: Prepare output directory
run: mkdir build

- name: Kramdown to XML
run: kramdown-rfc2629 webdav-push.mkd >build/draft-bitfire-webdav-push-00.xml
run: bundle exec kramdown-rfc2629 webdav-push.mkd >build/draft-bitfire-webdav-push-00.xml

- name: XML to HTML
run: (cd build; xml2rfc --html draft-bitfire-webdav-push-00.xml)
Expand Down
11 changes: 11 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
.idea/
.obsidian/
.refcache/

build/

# Node.js
node_modules/

# Python
.venv/

# Ruby
vendor/bundle/
Gemfile.lock
Binary file added .local/bin/goat
Binary file not shown.
2 changes: 2 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
source "https://rubygems.org"
gem "kramdown-rfc"
5 changes: 4 additions & 1 deletion build.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
#!/bin/sh

export KRAMDOWN_DONT_VERIFY_HTTPS=1

mkdir -p build
kramdown-rfc2629 -3 webdav-push.mkd >build/webdav-push.xml && (cd build; xml2rfc --html webdav-push.xml && xml2rfc --text webdav-push.xml)
bundle exec kramdown-rfc2629 -3 webdav-push.mkd >build/webdav-push.xml && (cd build; xml2rfc --html webdav-push.xml && xml2rfc --text webdav-push.xml)

echo To view in a browser, run: xdg-open build/webdav-push.html

4 changes: 2 additions & 2 deletions content.mkd
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Typical use cases:

## Overview

~~~goat
~~~aasvg
.--------------------. .--------------. .--------------------.
| WebDAV-Push Server | | Push Service | | WebDAV-Push Client |
'--------------------' '--------------' '--------------------'
Expand Down Expand Up @@ -468,7 +468,7 @@ Message encryption ({{message-encryption}}) MUST be used. VAPID(((VAPID))) ({{va

A server that supports the Web Push transport MUST list the `web-push` element(((web-push XML element))) in the `transports` property.

~~~goat
~~~aasvg
.--------------------. .--------------. .--------------------.
| | | Web Push | | |
| WebDAV-Push Server | | Service | | WebDAV-Push Client |
Expand Down
24 changes: 24 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"dependencies": {
"aasvg": "^0.4.3"
}
}
25 changes: 25 additions & 0 deletions prepare.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
#!/bin/sh
set -e

# This script installs all build dependencies locally:
# - Python dependencies in .venv/
# - Ruby gems in vendor/bundle/
# - Node.js dependencies in node_modules/
# After running this, you can run build.sh

# Python dependencies via venv
python3 -m venv .venv
. .venv/bin/activate
pip install -r requirements.txt
deactivate

# Ruby dependencies via bundler (local install)
bundle config set path 'vendor/bundle'
bundle install

# Node.js dependencies (aasvg)
npm install

echo "Dependencies installed successfully."
echo "To use them, prepend to PATH before running build.sh:"
echo " PATH=\"$(pwd)/.venv/bin:$(pwd)/vendor/bundle/bin:$(pwd)/node_modules/.bin:\"$PATH ./build.sh"
2 changes: 2 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
svgcheck
xml2rfc
5 changes: 3 additions & 2 deletions webdav-push.mkd
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ category: exp
submissionType: independent
ipr: none
workgroup: Independent submission
keyword: WebDAV
keyword: push
keyword:
- WebDAV
- push

stand_alone: yes
pi: [toc, sortrefs, symrefs]
Expand Down
Loading