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
92 changes: 92 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
name: documentation

on:
push:
paths:
- 'docs/**'
- 'mkdocs.yml'
- 'requirements-docs.*'
- 'scripts/docs-*'
- '.github/workflows/docs.yml'
- 'README.md'
- 'Cargo.lock'
- 'src/config.rs'
- 'src/cli.rs'
- 'src/distribution.rs'
pull_request:
paths:
- 'docs/**'
- 'mkdocs.yml'
- 'requirements-docs.*'
- 'scripts/docs-*'
- '.github/workflows/docs.yml'
- 'README.md'
- 'Cargo.lock'
- 'src/config.rs'
- 'src/cli.rs'
- 'src/distribution.rs'
workflow_dispatch:

permissions:
contents: read

jobs:
check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.12'
cache: pip
cache-dependency-path: requirements-docs.txt
- name: Install locked documentation tools
run: python -m pip install -r requirements-docs.txt
- name: Install pinned Chromium
run: python -m playwright install --with-deps chromium
- name: Build and exercise the documentation
run: python scripts/docs-check.py
- name: Upload the checked site
uses: actions/upload-artifact@v4
with:
name: prrr-documentation
path: target/docs-site
if-no-files-found: error
- name: Upload Pages site
if: github.ref == 'refs/heads/main' && github.event_name != 'pull_request'
uses: actions/upload-pages-artifact@v3
with:
path: target/docs-site

examples:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.12'
- uses: dtolnay/rust-toolchain@stable
- uses: Swatinem/rust-cache@v2
- name: Build the real documented CLI
run: cargo build --locked --bin prrr
- name: Check TOML examples and isolated provisioning workflows
run: python scripts/docs-examples-check.py

deploy:
if: github.ref == 'refs/heads/main' && github.event_name != 'pull_request'
needs: [check, examples]
runs-on: ubuntu-latest
permissions:
pages: write
id-token: write
concurrency:
group: github-pages
cancel-in-progress: false
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- uses: actions/configure-pages@v5
- name: Deploy checked documentation
id: deployment
uses: actions/deploy-pages@v4
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,7 @@ prrr-android/local.properties
.terraform/
.terraform.lock.hcl
terraform.tfvars

# Python documentation check caches
__pycache__/
*.pyc
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).

## [Unreleased]

### Security

- Update the locked rustls dependency from 0.23.45 to 0.23.46, resolving
RUSTSEC-2026-0346, RUSTSEC-2026-0347, RUSTSEC-2026-0348, and RUSTSEC-2026-0349.

### Changed

- **Split mode no longer asks the tunnel to resolve every name on the host**
Expand Down Expand Up @@ -79,6 +84,10 @@ The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).

### Added

- Cat-themed MkDocs documentation with 22 illustrated handshake, packet-flow,
and routing/recovery chapters, source-checked guides, browser/example checks,
and deployment to GitHub Pages. The live README links the canonical site.

- `[routing].resources` selective resource routing: config-driven hostnames
resolved to `/32` VPN routes, with `prrr client ... route add|remove|list`
CLI (specs/frds/FRD-resource-routing.md).
Expand Down
4 changes: 2 additions & 2 deletions Cargo.lock

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

Loading
Loading