Il s'agit du référentiel du groupe de travail WebAuthn du W3C, qui produit le projet de spécification « Web Authentication » .
gh-pages
de ce référentiel.Pour contribuer matériellement à cette spécification, vous devez répondre aux exigences décrites dans CONTRIBUTING.md. De plus, avant de soumettre vos commentaires, veuillez vous familiariser avec notre liste de problèmes actuels et consulter la discussion sur la liste de diffusion.
Le HTML formaté pour le brouillon peut être construit à l'aide bikeshed
(voir ci-dessous pour les instructions d'installation bikeshed
) :
$ bikeshed spec
Vous souhaiterez peut-être également utiliser la fonctionnalité watch
pour régénérer automatiquement à mesure que vous apportez des modifications :
$ bikeshed watch
Consultez les instructions complètes sur https://tabatkins.github.io/bikeshed/#installing.
Vous devrez installer Python 3.7 ou version ultérieure. Une fois Python 3.7 ou version ultérieure installé, pour installer Bikeshed lui-même, exécutez ce qui suit :
pip3 install bikeshed && bikeshed update
Une fois cela terminé, Bikeshed devrait être installé et la commande bikeshed
devrait fonctionner dans votre shell.
https://w3c.github.io/webauthn/ est publié automatiquement à partir de la branche gh-pages
à chaque poussée vers la branche main
, en utilisant https://github.com/w3c/webauthn/blob/main/.github/workflows/ build-validate-publish.yml pour configurer le comportement de publication automatique.
Pour créer un nouveau WD et le télécharger sur le système de publication du W3C :
bikeshed update
bikeshed spec
bikeshed echidna --u USERNAME --p PASSWORD --d DECISION_URL
La commande ci-dessus créera une archive tar du HTML et des images, et la téléchargera sur Echidna, le système de publication automatisé du W3C. La commande doit renvoyer une URL, grâce à laquelle vous pouvez savoir si vous avez publié avec succès le brouillon. Le statut de la demande peut également être suivi via les archives de la liste de diffusion. Vous pouvez également utiliser l'API W3C comme décrit dans la documentation Echidna. Notez que sous Windows, cela générera une erreur indiquant l'échec de la suppression d'un fichier temporaire car il est utilisé par un processus différent. Cette erreur est inoffensive ; cela se produit une fois la soumission terminée.
Si la publication via le processus échoue, c'est probablement à cause de Specbreus, un vérificateur de conformité aux spécifications. Echidna exécute automatiquement Specbreus et rejettera la publication si une erreur est signalée par Specbreus. Vous pouvez exécuter votre document via Pubrules pour comprendre pourquoi votre document est rejeté. Vous pouvez modifier soit le fichier index.bs, soit le fichier index.html pour garantir la conformité.
Le plus souvent, vous découvrirez que les erreurs Pubrules sont dues à des bugs dans Bikeshed ou Specbreus. Si tel est le cas, vous devrez modifier le fichier index.html compilé pour contourner Echidna et utiliser le processus manuel pour publier. Pendant que vous modifiez le fichier HTML pour éviter les erreurs, vous devez également vérifier que le document s'affiche toujours correctement.
Le processus manuel nécessite que vous créiez d’abord un fichier tar. Pour créer le fichier tar, vous devez d'abord copier le fichier index.html et renommer le fichier copié en Overview.html. C'est parce qu'Echidna ne reconnaît pas index.html. Vous pouvez ensuite utiliser la commande suivante pour créer un fichier tar :
tar -cvf WD.tar Overview.html image1 image2 image3
Ensuite, vous pouvez exécuter la commande suivante curl pour publier sur Echidna (utilisez la commande dans le même répertoire que votre fichier tar) :
curl 'https://labs.w3.org/echidna/api/request' --user '<username>:<password>' -F "[email protected]" -F "decision=<decisionUrl>"
N'hésitez pas à contacter votre président ou n'importe quel membre du personnel du W3C lorsque vous êtes bloqué. Les informations générales sur l'échidné sont ici : https://github.com/w3c/echidna/wiki et ici https://labs.w3.org/echidna/.