Skip to content

Commit a9f0c06

Browse files
chore: sync versions, add badges, and setup gh pages docs
Synchronized all packages to v1.8.0 for unified versioning. Update README with status badges, GH Pages links. Created documentation sync tooling and manual deployment workflow. Changes: - All packages synced to 1.8.0 (unified versioning) - Release-please manifest updated to match published packages - Added status badges and docs link to README - Created docs:deploy-manual workflow for GitHub Pages - Added sync:docs npm script + CONTRIBUTING.md documentation - Excluded CHANGELOG.md from prettier (auto-generated) - Excluded example_worker.py from linting (example code) Documentation now available at: https://chrislyons-dev.github.io/flarelette-jwt-kit/ Written-by: Chris Lyons
1 parent 0ece844 commit a9f0c06

16 files changed

Lines changed: 473 additions & 22 deletions
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
22
"packages/flarelette-jwt-ts": "1.8.0",
3-
"packages/flarelette-jwt-py": "0.1.1"
3+
"packages/flarelette-jwt-py": "1.8.0"
44
}
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Deploy Docs (Manual)
2+
3+
on:
4+
workflow_dispatch:
5+
6+
permissions:
7+
contents: write
8+
9+
jobs:
10+
deploy:
11+
name: Deploy Documentation to GitHub Pages
12+
runs-on: ubuntu-latest
13+
14+
steps:
15+
- name: Checkout code
16+
uses: actions/checkout@v4
17+
with:
18+
fetch-depth: 0
19+
20+
- name: Setup Python
21+
uses: actions/setup-python@v5
22+
with:
23+
python-version: '3.11'
24+
25+
- name: Install MkDocs and dependencies
26+
run: |
27+
pip install --upgrade pip
28+
pip install mkdocs-material mkdocs-minify-plugin pymdown-extensions
29+
30+
- name: Configure Git
31+
run: |
32+
git config user.name "github-actions[bot]"
33+
git config user.email "github-actions[bot]@users.noreply.github.com"
34+
35+
- name: Deploy to GitHub Pages
36+
run: mkdocs gh-deploy --force

.gitignore

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,11 +55,9 @@ yarn-error.log*
5555
*.tmp
5656
.cache/
5757
coverage/
58+
.coverage
5859

5960
# Documentation (if you want to keep these private)
6061
CLAUDE.md
6162
.claude/
6263
notes/
63-
packages/flarelette-jwt-py/CONTRIBUTING.md
64-
packages/flarelette-jwt-py/THIRD_PARTY_LICENSES.md
65-
packages/flarelette-jwt-py/LICENSE

.prettierignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ output/
1818
docs/architecture/
1919
site/
2020

21+
# Generated files
22+
**/CHANGELOG.md
23+
2124
# Config
2225
package-lock.json
2326
yarn.lock

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,14 @@
88

99
# Flarelette JWT Kit
1010

11+
[![npm version](https://img.shields.io/npm/v/@chrislyons-dev/flarelette-jwt.svg?style=flat-square&logo=npm&label=npm)](https://www.npmjs.com/package/@chrislyons-dev/flarelette-jwt)
12+
[![PyPI version](https://img.shields.io/pypi/v/flarelette-jwt.svg?style=flat-square&logo=pypi&label=pypi)](https://pypi.org/project/flarelette-jwt/)
13+
[![npm downloads](https://img.shields.io/npm/dm/@chrislyons-dev/flarelette-jwt.svg?style=flat-square&label=npm%20downloads)](https://www.npmjs.com/package/@chrislyons-dev/flarelette-jwt)
14+
[![PyPI downloads](https://img.shields.io/pypi/dm/flarelette-jwt.svg?style=flat-square&label=pypi%20downloads)](https://pypi.org/project/flarelette-jwt/)
15+
[![CI Status](https://img.shields.io/github/actions/workflow/status/chrislyons-dev/flarelette-jwt-kit/ci.yml?branch=main&style=flat-square&logo=github&label=ci)](https://github.com/chrislyons-dev/flarelette-jwt-kit/actions/workflows/ci.yml)
16+
[![License](https://img.shields.io/github/license/chrislyons-dev/flarelette-jwt-kit.svg?style=flat-square&label=license)](https://github.com/chrislyons-dev/flarelette-jwt-kit/blob/main/LICENSE)
17+
[![Documentation](https://img.shields.io/badge/docs-github%20pages-blue?style=flat-square&logo=readme)](https://chrislyons-dev.github.io/flarelette-jwt-kit/)
18+
1119
**Environment-driven JWT authentication for Cloudflare Workers. Like Starlette, but for the edge.**
1220

1321
Cross-language JWT toolkit (TypeScript + Python) with identical APIs. Automatically selects HS512 or EdDSA based on environment configuration, loads secrets via Cloudflare bindings, and works across Workers, Node.js, and Python runtimes.

THIRD_PARTY_LICENSES.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ The TypeScript package depends on the following NPM packages:
1414
### TypeScript Package Dependencies Summary
1515

1616
```
17-
@flarelette/jwt-kit-env@0.1.0
17+
@flarelette/jwt-kit-env@1.8.0
1818
│ C:\Users\chris\git\flarelette-jwt-kit
1919
20-
└─┬ @chrislyons-dev/flarelette-jwt@0.1.0 -> .\packages\flarelette-jwt-ts
20+
└─┬ @chrislyons-dev/flarelette-jwt@1.8.0 -> .\packages\flarelette-jwt-ts
2121
│ Environment-driven JWT authentication for Cloudflare Workers with secret-name indirection
2222
└── jose@5.10.0
2323
JWA, JWS, JWE, JWT, JWK, JWKS for Node.js, Browser, Cloudflare Workers, Deno, Bun, and other Web-interoperable runtimes

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@flarelette/jwt-kit-env",
3-
"version": "0.1.0",
3+
"version": "1.8.0",
44
"type": "module",
55
"private": true,
66
"scripts": {

packages/flarelette-jwt-py/CHANGELOG.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,14 @@
22

33
## [0.1.1](https://github.com/chrislyons-dev/flarelette-jwt-kit/compare/flarelette-jwt-v0.1.0...flarelette-jwt-v0.1.1) (2025-10-31)
44

5-
65
### Features
76

8-
* initial merge of flarelette-jwt-kit (ts+py) - env-driven hs512/eddsa, jwks, policy builder ([be132e2](https://github.com/chrislyons-dev/flarelette-jwt-kit/commit/be132e2ac12a1460843a8a1739386c7905deaee1))
9-
7+
- initial merge of flarelette-jwt-kit (ts+py) - env-driven hs512/eddsa, jwks, policy builder ([be132e2](https://github.com/chrislyons-dev/flarelette-jwt-kit/commit/be132e2ac12a1460843a8a1739386c7905deaee1))
108

119
### Bug Fixes
1210

13-
* lazy-load js module and add ci smoke test to prevent import failures ([1f74caa](https://github.com/chrislyons-dev/flarelette-jwt-kit/commit/1f74caacb6ae2bc1cb0366f59cc96e0c4b16d234))
14-
11+
- lazy-load js module and add ci smoke test to prevent import failures ([1f74caa](https://github.com/chrislyons-dev/flarelette-jwt-kit/commit/1f74caacb6ae2bc1cb0366f59cc96e0c4b16d234))
1512

1613
### Miscellaneous
1714

18-
* add sync:docs script and documentation for readme syncing ([6630372](https://github.com/chrislyons-dev/flarelette-jwt-kit/commit/6630372a5ee5a42e193be5d7d688661f2cfefff2))
15+
- add sync:docs script and documentation for readme syncing ([6630372](https://github.com/chrislyons-dev/flarelette-jwt-kit/commit/6630372a5ee5a42e193be5d7d688661f2cfefff2))

0 commit comments

Comments
 (0)