diff --git a/deadlock-plugins/deadlock-extension/README.md b/deadlock-plugins/deadlock-extension/README.md index 4242173929213d92955f5c0bf4520390c51b064b..91c9962fd4f2ca335bfea29dc379919fbc6c46ac 100644 --- a/deadlock-plugins/deadlock-extension/README.md +++ b/deadlock-plugins/deadlock-extension/README.md @@ -1,13 +1,3 @@ -## Deadlock Coding extension +# Deadlock Coding extension This extension was created to allow you to do some of the [Deadlock](https://www.deadlock.io) platform exercises directly on your Visual Studio Code IDE - -## Troubleshoots - -### node-fetch - -Nous devons downgrade la version de node-fetch, pour que les tests soient fonctionnels car il y a un problèmes avec les modules es6. - -**Source :** - -https://github.com/node-fetch/node-fetch/issues/1266 diff --git a/deadlock-plugins/deadlock-extension/dev/README.md b/deadlock-plugins/deadlock-extension/dev/README.md index b2fb4782cd70d06ce2ca9fe91c679f9dc6ab2e7c..1ce085563ef3a2821f534eb958fcc234d7c7a692 100644 --- a/deadlock-plugins/deadlock-extension/dev/README.md +++ b/deadlock-plugins/deadlock-extension/dev/README.md @@ -19,7 +19,7 @@ Le pipeline a besoin d'un token provenant de la marketplace pour y publier l'ext - La méthode pour obtenir le token est décrite [ici](https://code.visualstudio.com/api/working-with-extensions/publishing-extension#get-a-personal-access-token) - Le token doit être inséré en tant que valeur de la variable `VSCODE_EXTENSION_MARKET_PLACE_ACCESS_TOKEN` -**Le token a une durée de vie maximale de 1 an** +> Le token a une durée de vie maximale de **1 an** ## Gestion de la production et de la pré-production @@ -31,7 +31,7 @@ Pour le moment, la marketplace de Vscode ne supporte pas totalement le `semver`( 2. Lorsque le travail est poussé sur la branche `master`, une version de l'extension est poussé en `pre-release` sur la marketplace. -### Constuire une version release +### Construire une version release 1. Monter la version de l'extension avec `npm version`. Vous pouvez voir comment utiliser la commande [ici](https://docs.npmjs.com/cli/v8/commands/npm-version). @@ -42,7 +42,7 @@ git tag [X.Y.Z] git push origin [taBranch] --tags ``` -### Publier l'extention à la main +### Publier l’extension à la main Les commandes nécessaires sont prédéfinies dans le package.json : @@ -66,15 +66,25 @@ Configuration de base : Steps: -1. Aller sur https://www.dev.deadlock.io/. La page d'authentification doit apparaitre. +1. Aller sur [Deadlock](https://www.dev.deadlock.io/). La page d'authentification doit apparaître. 2. Se connecter via Google. Être redirigé vers la page d'accueil. 3. Sélectionner et lancer une mission du type `desktop`. Les instructions de la mission doivent apparaître sur la page. 4. Tous les liens sur la page de la mission doivent fonctionner : installation de dépendances, la page de l'extension sur la marketplace, et le lien xdg-open permettant d'ouvrir Vscode. -5. Lorsque VS Code est ouvert, une fenêtre doit apparaitre et suggérer l'installation de l'extension. Accepter l'installation. L'installation doit fonctionner et une notification de bienvenue doit apparaître. -6. Désinstaller l'extension, relancer l'IDE, et chercher `deadlock` dans la barre de recherche de la `marketplace`. L'extension doit apparaitre dans les 3 premiers résultats. Reinstaller l'extension. +5. Lorsque VS Code est ouvert, une fenêtre doit apparaître et suggérer l'installation de l'extension. Accepter l'installation. L'installation doit fonctionner et une notification de bienvenue doit apparaître. +6. Désinstaller l'extension, relancer l'IDE, et chercher `deadlock` dans la barre de recherche de la `marketplace`. L'extension doit apparaître dans les 3 premiers résultats. Réinstaller l'extension. 7. Re-cliquer sur le lien de l'exercice dans le navigateur. La fenêtre demandant de choisir un dossier pour les exercices doit s'ouvrir. -8. Sélectionner un dossier ne nécessitant pas de droits d'accès. Une page doit s'ouvrir dans le navigateur par défault pour permettre à l'utilisateur de s'authentifier. +8. Sélectionner un dossier ne nécessitant pas de droits d'accès. Une page doit s'ouvrir dans le navigateur par défaut pour permettre à l'utilisateur de s'authentifier. 9. S'authentifier avec Google et retourner dans VSCode. Une notification de connexion doit s'afficher. 10. Ouvrir la page de l'extension, elle doit indiquer que les étapes précédentes (choix du dossier et authentification) ont été validées. -11. Une fois authentifié, VSCode doit se réouvrir automatiquement dans le `devcontainer`. L'arborescence de fichiers doit être montée dans le dossier des exercices. +11. Une fois authentifié, VSCode doit se rouvrir automatiquement dans le `devcontainer`. L'arborescence de fichiers doit être montée dans le dossier des exercices. 12. Ouvrir le terminal de VSCode. L'utilisateur en cours doit être `deadlock` et les bibliothèques et exécutables nécessaires à la mission doivent être présents (ex: docker, java, node, ...). + +## Troubleshoots + +### node-fetch + +Nous devons downgrade la version de node-fetch, pour que les tests soient fonctionnels car il y a un problèmes avec les modules es6. + +**Source :** + +[Issue 1266 de node-fetch](https://github.com/node-fetch/node-fetch/issues/1266) diff --git a/deadlock-plugins/deadlock-extension/sync-version.sh b/deadlock-plugins/deadlock-extension/sync-version.sh new file mode 100644 index 0000000000000000000000000000000000000000..05a7907cf5a4a5927d09b1e964aae97a096908f6 --- /dev/null +++ b/deadlock-plugins/deadlock-extension/sync-version.sh @@ -0,0 +1,2 @@ +#!/bin/bash +