You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-26Lines changed: 7 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ This is the repository for the W3C WebAuthn Working Group, producing the draft *
5
5
6
6
*[The editor's copy is available at https://w3c.github.io/webauthn/](https://w3c.github.io/webauthn/), or in the [`gh-pages` branch of this repository](https://github.com/w3c/webauthn/blob/gh-pages/index.html).
7
7
- The current *offically-published working-draft snapshot*[is here: https://www.w3.org/TR/webauthn/](https://www.w3.org/TR/webauthn/).
8
-
*[The build history is available at Travis-CI.org](https://travis-ci.org/w3c/webauthn/builds)
8
+
*[The build history is available from the repo Actions tab](https://github.com/w3c/webauthn/actions)
You will need to have the Python tools `pygments` and `bikeshed` to build the draft. Pygments can be obtained via `pip`, but Bikeshed will need to be downloaded with `git`:
32
+
See the full instructions at https://tabatkins.github.io/bikeshed/#installing.
Alternatively, you can use the [Vagrant VM with `bikeshed` already installed](vagrant/bikeshed), or the [Docker image](docker/bikeshed).
42
-
43
-
# Updating copies of Bikeshed data files stored in this repo
44
-
45
-
For the purpose of giving consistent builds, copies of some Bikeshed data files are stored in this repository and used by the CI build to auto-publish the https://w3c.github.io/webauthn/ draft.
46
-
47
-
The repository copies of those Bikeshed data files must be periodicallly updated and re-committed. To update and re-commit them, run the following commands:
34
+
You will need to have the Python 3.7 or later installed. Once you do have Python 3.7 or later installed, to install Bikeshed itself, run the following:
48
35
49
36
```
50
-
cd <your local w3c/webauthn repo clone or fork clone>
51
-
git checkout master
52
-
git pull # if necessary...
53
-
git checkout -b <a new branch name>
54
-
./update-bikeshed-cache.sh \
55
-
&& git add .spec-data .bikeshed-include \
56
-
&& git commit -m "Bikeshed spec data update" . \
57
-
&& git push
58
-
<in the w3c/webauthn repo create a pull request for this new branch, have it reviewed and merged>
37
+
pip3 install bikeshed && bikeshed update
59
38
```
60
39
40
+
When that is completed, Bikeshed should be installed, and the `bikeshed` command should work in your shell.
41
+
61
42
# Continuous Integration & Branches
62
43
63
-
This repository uses `.deploy-output.sh` to generate the Editor's Draft on the `gh-pages` branch upon every merge to `master`. In order to prevent failed merges during continuous integration, the formatted Editor's Draft should not be checked in to `master`, and it is in the `.gitignore` file.
44
+
https://w3c.github.io/webauthn/ is autopublished from the `gh-pages` branch on every push to the `main` branch, using https://github.com/w3c/webauthn/blob/main/.github/workflows/build-validate-publish.ymlto configure the autopublishing behavior.
0 commit comments