Skip to content

Commit 437113e

Browse files
jeremijeremi
committed
Initial Registry Stack identifier resolver
Signed-off-by: Jeremi Joslin <jeremi@joslin.fr>
0 parents  commit 437113e

427 files changed

Lines changed: 44307 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/deploy-cloudflare-workers.yml‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: Deploy Cloudflare Workers
2+
3+
on:
4+
push:
5+
branches: [main]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
deployments: write
11+
12+
concurrency:
13+
group: cloudflare-workers-${{ github.ref }}
14+
cancel-in-progress: false
15+
16+
jobs:
17+
deploy:
18+
name: Deploy to Cloudflare Workers
19+
runs-on: ubuntu-latest
20+
steps:
21+
- name: Checkout
22+
uses: actions/checkout@v4
23+
24+
- name: Setup Node
25+
uses: actions/setup-node@v4
26+
with:
27+
node-version: "22"
28+
29+
- name: Check generated output
30+
run: npm test
31+
32+
- name: Build static site
33+
run: npm run build
34+
35+
- name: Deploy to Cloudflare Workers
36+
uses: cloudflare/wrangler-action@v3
37+
with:
38+
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
39+
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
40+
command: deploy
41+
gitHubToken: ${{ secrets.GITHUB_TOKEN }}

‎.gitignore‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
.DS_Store
2+
node_modules/
3+
.wrangler/
4+
.cloudflare/
5+
tmp/

‎LICENSE‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright 2026 Jeremi Joslin
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md‎

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
# Registry Stack identifiers
2+
3+
This repository prepares the static site for `https://id.registrystack.org/`.
4+
It hosts stable machine identifiers owned by Registry Stack: problem type URIs,
5+
JSON-LD namespaces, JSON Schemas, JSON-LD contexts, and SHACL shape identifiers.
6+
7+
Deployment is configured for Cloudflare Workers Static Assets with:
8+
9+
- Worker name: `registrystack-id`
10+
- Build command: `npm run build`
11+
- Asset directory: `public`
12+
- Route: `id.registrystack.org/*`
13+
14+
## Identifier policy
15+
16+
Published identifiers are stable contracts.
17+
18+
- Do not repurpose an identifier after publication.
19+
- Do not delete a published identifier without marking it deprecated and
20+
linking to a replacement when one exists.
21+
- Use lowercase product scopes in paths: `registry-relay`, `registry-notary`,
22+
`registry-platform`, and `registry-manifest`.
23+
- Use `code` for programmatic branching in client code. Problem `type` URLs are
24+
identifiers and documentation pointers, not a parsing interface.
25+
- Keep generated static files in sync with `src/catalogs/`.
26+
27+
## Content quality rules
28+
29+
This site is an identifier resolver, not a replacement for the product docs.
30+
Generated pages may summarize existing public facts and link to documentation,
31+
but they must not introduce new runtime guarantees unless those guarantees are
32+
backed by source code, tests, schemas, or published product documentation.
33+
34+
Problem pages separate:
35+
36+
- Defined facts: canonical URI, product, code, category when known, and source.
37+
- Documentation links: public Registry Stack docs that remain authoritative for
38+
operational behavior.
39+
- Guidance: explicitly marked as `not_published` unless it has been curated.
40+
41+
Problem records deliberately leave `http_statuses`, `retryable`,
42+
`caller_action`, and `operator_action` as `null` when the resolver has no
43+
curated value. Clients should use the RFC 9457 response body, especially
44+
`code`, `status`, and `detail`, for request-specific behavior.
45+
46+
## Local definition of done
47+
48+
For the first publishable version, the local checkout is done when:
49+
50+
- Every generated identifier page states the authority boundary.
51+
- Problem JSON records include `guidance.status`, `documented_by`, `authority`,
52+
`identifier_policy`, and `source_reference`.
53+
- Generated pages link to public documentation on `docs.registrystack.org`
54+
where an appropriate page exists.
55+
- Unknown guidance remains explicit instead of inferred.
56+
- Generated Cloudflare header rules stay compact and readable.
57+
- `public/` is regenerated from `src/` and `npm test` passes.
58+
- Cloudflare project creation, DNS changes, deployment, push, or PR are not
59+
required for the local preparation step.
60+
61+
## Local workflow
62+
63+
Generate problem entries from a local `registry-stack` checkout:
64+
65+
```sh
66+
REGISTRY_STACK_DIR=../registry-stack npm run import:problems
67+
```
68+
69+
Build the static site:
70+
71+
```sh
72+
npm run build
73+
```
74+
75+
Check that `public/` matches the catalogs and copied schema/context artifacts:
76+
77+
```sh
78+
npm test
79+
```
80+
81+
## Cloudflare Workers preparation
82+
83+
The repository includes `wrangler.jsonc` so Wrangler deploys `public/` as
84+
Workers static assets on the `registrystack-id` service. The compatibility date
85+
is pinned because Wrangler does not store the dashboard's `Latest`
86+
compatibility-date setting in source control.
87+
88+
The generated `public/_headers` file sets content types, CORS for machine
89+
artifacts, and conservative cache headers.
90+
The generated `public/_redirects` file reserves compatibility routes that can
91+
be expanded later without changing the identifier policy.
92+
93+
### Cloudflare setup
94+
95+
The Cloudflare account is configured with:
96+
97+
- Worker name: `registrystack-id`
98+
- Static assets source: `public/`
99+
- Worker preview URL: `https://registrystack-id.jeremi-ccf.workers.dev/`
100+
- DNS record: proxied `AAAA id -> 100::`
101+
- Worker route: `id.registrystack.org/*` in the `registrystack.org` zone
102+
103+
Deploy locally with:
104+
105+
```sh
106+
npm run build
107+
npx wrangler deploy
108+
```
109+
110+
### GitHub Actions deployment
111+
112+
The `.github/workflows/deploy-cloudflare-workers.yml` workflow deploys `public/`
113+
to Cloudflare Workers on pushes to `main` and on manual dispatch. Configure
114+
these repository secrets before enabling it:
115+
116+
- `CLOUDFLARE_ACCOUNT_ID`
117+
- `CLOUDFLARE_API_TOKEN` with Workers Scripts Edit and DNS Edit permissions for
118+
the `registrystack.org` zone
119+
120+
The initial deployment, DNS record, and Worker route were created manually from
121+
the Cloudflare dashboard.

‎package.json‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"name": "registrystack-id",
3+
"version": "0.1.0",
4+
"private": true,
5+
"type": "module",
6+
"description": "Static identifier registry for id.registrystack.org.",
7+
"scripts": {
8+
"import:problems": "node scripts/import-registry-stack-problems.mjs",
9+
"build": "node scripts/build.mjs",
10+
"check": "node scripts/check.mjs",
11+
"check:upstream": "node scripts/check-upstream-artifacts.mjs",
12+
"test": "npm run check"
13+
},
14+
"engines": {
15+
"node": ">=22.12.0"
16+
}
17+
}

0 commit comments

Comments
 (0)