Это репозиторий рабочей группы W3C WebAuthn, создающей проект спецификации веб-аутентификации .
gh-pages
этого репозитория.Чтобы внести существенный вклад в эту спецификацию, вы должны соответствовать требованиям, изложенным в CONTRIBUTING.md. Кроме того, прежде чем отправлять отзыв, ознакомьтесь с нашим списком текущих проблем и просмотрите обсуждение в списке рассылки.
Отформатированный HTML для черновика можно создать с помощью bikeshed
(инструкции по установке bikeshed
см. ниже):
$ bikeshed spec
Вы также можете использовать функцию watch
для автоматического восстановления при внесении изменений:
$ bikeshed watch
Полные инструкции см. на странице https://tabatkins.github.io/bikeshed/#installing.
Вам потребуется установить Python 3.7 или более поздней версии. Если у вас установлен Python 3.7 или более поздняя версия, чтобы установить сам Bikeshed, выполните следующую команду:
pip3 install bikeshed && bikeshed update
Когда это будет завершено, Bikeshed должен быть установлен, и команда bikeshed
должна работать в вашей оболочке.
https://w3c.github.io/weauthn/ автоматически публикуется из ветки gh-pages
при каждом нажатии на main
ветку с использованием https://github.com/w3c/weauthn/blob/main/.github/workflows/ build-validate-publish.yml для настройки поведения автоматической публикации.
Чтобы создать новый WD и загрузить его в систему публикации W3C:
bikeshed update
bikeshed spec
bikeshed echidna --u USERNAME --p PASSWORD --d DECISION_URL
Приведенная выше команда создаст архив HTML и изображений и загрузит его в Echidna, автоматизированную систему публикации W3C. Команда должна вернуть URL-адрес, по которому вы сможете узнать, успешно ли вы опубликовали черновик. Статус запроса также можно отслеживать через Архив списка рассылки. Вы также можете использовать W3C API, как описано в документации Echidna. Обратите внимание, что в Windows это приведет к ошибке о невозможности удаления временного файла, поскольку он используется другим процессом. Эта ошибка безвредна; это происходит после завершения подачи.
Если публикация в процессе не удалась, скорее всего, это произошло из-за Specbreus, средства проверки соответствия спецификациям. Echidna автоматически проходит через Specbreus и отклонит публикацию, если Specbreus сообщит о какой-либо ошибке. Вы можете запустить свой документ через Pubrules, чтобы понять, почему ваш документ отклонен. Вы можете изменить файл index.bs или файл index.html, чтобы обеспечить соответствие.
Чаще всего вы обнаружите, что ошибки Pubrules вызваны ошибками в Bikeshed или Specbreus. В этом случае вам придется изменить скомпилированный файл index.html, чтобы обойти Echidna и использовать ручной процесс публикации. Во время редактирования html-файла, чтобы избежать ошибок, вам также следует убедиться, что документ по-прежнему отображается правильно.
Ручной процесс требует, чтобы вы сначала создали файл tar. Чтобы создать файл tar, вам необходимо сначала скопировать файл index.html и переименовать скопированный файл в Обзор.html. Это связано с тем, что Echidna не распознает index.html. Затем вы можете использовать следующую команду для создания файла tar:
tar -cvf WD.tar Overview.html image1 image2 image3
Затем вы можете запустить следующую команду Curl для публикации в Echidna (используйте команду в том же каталоге, что и ваш tar-файл):
curl 'https://labs.w3.org/echidna/api/request' --user '<username>:<password>' -F "[email protected]" -F "decision=<decisionUrl>"
Не стесняйтесь обращаться к своему руководителю или к любому сотруднику W3C, если вы застряли. Общая информация о ехидне находится здесь: https://github.com/w3c/echidna/wiki и здесь https://labs.w3.org/echidna/.