Files proposed by Working Group draft editors should be added into the corresponding sub-directory via a branch in this repository that follows the pattern propose/**. Pull requests from forks are not supported — the publication automation (checks, previews, and the approval flow) cannot run on them.
Working Group co-chairs or editors will have access rights granted that allow them to commit only to sub-directories that are pertinent to their Working Group(s).
The proposed document sets should be as described in https://openid.net/wg/resources/naming-and-contents-of-specifications/
- Create a branch in this repository (not a fork) following the
propose/{wg-name}pattern — if you don't have write access, ask your working group's editors or the OIDF secretary to push the files for you - Add your HTML, source (.md or .xml), and .zip files to the appropriate WG sub-directory
- Create a Pull Request from your branch to
main - The automated checks will run and post a comment on the PR showing any issues
- A preview of the HTML specs will be deployed to GitHub Pages with clickable links in a PR comment
- Fix any failures and push again - checks and preview update automatically
- Once ready, request a review from the Secretary team (or a WG co-chair for drafts)
- On approval, the publish prep workflow posts a preview of the files and URLs that will be published
- Merge the PR
- On merge, the publish workflow generates the correctly-named files in
sync/specs/, deploys to https://openid.net/specs/, purges CDN caches, and comments on the PR with the published URLs
Details of how to fix the various check errors are documented in ERROR-MODES.md.
- HTML file is required
- Either a
.mdor.xmlsource file is required (with matching filename) - A
.zipfile is required if the source references external files (e.g.,<{{examples/file.json}}) - A
.zipis also required if the previous version of the spec included one - Draft numbers must be two digits, zero-padded (e.g.,
-01not-1) - Draft numbers start at
-00