Skip to content

Commit

Permalink
Update build & (auto)publishing info in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sideshowbarker committed Jun 16, 2021
1 parent 1823a4b commit 4261878
Showing 1 changed file with 7 additions and 26 deletions.
33 changes: 7 additions & 26 deletions README.md
Expand Up @@ -5,7 +5,7 @@ This is the repository for the W3C WebAuthn Working Group, producing the draft *

* [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).
- The current *offically-published working-draft snapshot* [is here: https://www.w3.org/TR/webauthn/](https://www.w3.org/TR/webauthn/).
* [The build history is available at Travis-CI.org](https://travis-ci.org/w3c/webauthn/builds)
* [The build history is available from the repo Actions tab](https://github.com/w3c/webauthn/actions)
* [W3C WebAuthn Blog](https://www.w3.org/blog/webauthn/)
* [Web platform tests repository](https://github.com/web-platform-tests/wpt/tree/master/webauthn)

Expand All @@ -29,38 +29,19 @@ $ bikeshed watch

# Bikeshed Installation and Setup

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`:
See the full instructions at https://tabatkins.github.io/bikeshed/#installing.

```
git clone --depth=1 --branch=main https://github.com/tabatkins/bikeshed.git ./bikeshed
pip install pygments
pip install --editable ./bikeshed
cp -R .spec-data/* ./bikeshed/bikeshed/spec-data
```

Alternatively, you can use the [Vagrant VM with `bikeshed` already installed](vagrant/bikeshed), or the [Docker image](docker/bikeshed).

# Updating copies of Bikeshed data files stored in this repo

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.

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:
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:

```
cd <your local w3c/webauthn repo clone or fork clone>
git checkout master
git pull # if necessary...
git checkout -b <a new branch name>
./update-bikeshed-cache.sh \
&& git add .spec-data .bikeshed-include \
&& git commit -m "Bikeshed spec data update" . \
&& git push
<in the w3c/webauthn repo create a pull request for this new branch, have it reviewed and merged>
pip3 install bikeshed && bikeshed update
```

When that is completed, Bikeshed should be installed, and the `bikeshed` command should work in your shell.

# Continuous Integration & Branches

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

# Creating a new Working Draft

Expand Down

0 comments on commit 4261878

Please sign in to comment.