Skip to content

Commit 6216fa7

Browse files
Update build & (auto)publishing info in README.md (w3c#1628)
1 parent 1823a4b commit 6216fa7

File tree

1 file changed

+7
-26
lines changed

1 file changed

+7
-26
lines changed

README.md

Lines changed: 7 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This is the repository for the W3C WebAuthn Working Group, producing the draft *
55

66
* [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).
77
- 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)
99
* [W3C WebAuthn Blog](https://www.w3.org/blog/webauthn/)
1010
* [Web platform tests repository](https://github.com/web-platform-tests/wpt/tree/master/webauthn)
1111

@@ -29,38 +29,19 @@ $ bikeshed watch
2929

3030
# Bikeshed Installation and Setup
3131

32-
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.
3333

34-
```
35-
git clone --depth=1 --branch=main https://github.com/tabatkins/bikeshed.git ./bikeshed
36-
pip install pygments
37-
pip install --editable ./bikeshed
38-
cp -R .spec-data/* ./bikeshed/bikeshed/spec-data
39-
```
40-
41-
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:
4835

4936
```
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
5938
```
6039

40+
When that is completed, Bikeshed should be installed, and the `bikeshed` command should work in your shell.
41+
6142
# Continuous Integration & Branches
6243

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.yml to configure the autopublishing behavior.
6445

6546
# Creating a new Working Draft
6647

0 commit comments

Comments
 (0)