Partager des livres de cuisine au sein d'une équipe

Partager des livres de cuisine au sein d'une équipe

Lorsqu'une personne crée une recette Sensei pour améliorer la qualité de son code ou sa productivité, tous les membres de l'équipe peuvent bénéficier du partage des livres de recettes.

Sensei propose un certain nombre de mécanismes pour partager des livres de cuisine :

• Stockez les livres de recettes dans le projet sous contrôle de version
• Stockage des livres de recettes dans un dossier partagé
• Stockez des livres de recettes sur Github
• Fichiers compressés via HTTP (s)

En partageant les livres de recettes, Sensei aide les équipes à collaborer sur le partage des connaissances. La collaboration permet d'améliorer la communication et d'intégrer les approches convenues en matière de qualité du code.

Par exemple, partager un livre de recettes :

• aide les membres de l'équipe à partager des recettes utiles entre eux.
• aide les chefs d'équipe à codifier les pratiques de codage convenues, pour le personnel subalterne, afin d'identifier les violations courantes et de trouver une solution rapide à la version convenue.
• favorise une coopération accrue entre les équipes, par exemple une équipe AppSec peut créer des recettes pour mettre en évidence un problème dans le code, et l'équipe de développement pourrait écrire la solution rapide.

Les sections suivantes expliquent comment mettre en œuvre chacun des mécanismes de partage.

Stockez les livres de recettes dans le projet sous contrôle de version

Le dossier .sensei du projet est l'option par défaut lors de la création d'un fichier de livre de recettes.

• `projet : //.sensei`

Tous les livres de recettes et recettes seraient stockés dans un dossier .sensei de votre projet.

L'approche la plus simple pour partager est d'ajouter le dossier .sensei du projet au contrôle de version.

Ensuite, le dossier .sensei peut être géré comme n'importe quel autre artefact de code partagé associé au projet. Les livres de recettes sont stockés en tant que configuration YAML, ce qui facilite leur fusion lors de tout processus de validation et de révision.

C'est l'approche adoptée pour le projet public sensei-blog-examples.

• https://github.com/SecureCodeWarrior/sensei-blog-examples

Le dossier .sensei contient le livre de recettes avec toutes les recettes, et elles sont accessibles à tous ceux qui clonent le référentiel.

Rangez les livres de cuisine dans n'importe quel dossier

Les équipes peuvent également utiliser des livres de recettes stockés dans des emplacements centraux.

L'enregistrement du livre de recettes dans n'importe quel dossier doté d'autorisations d'écriture partagées permettra à toute l'équipe de mettre à jour les recettes et de les importer dans n'importe quel projet sur lequel elle travaille.

L'emplacement serait défini sur le chemin du répertoire.

Stockez les recettes sur Github

Sensei peut également accéder à des recettes stockées dans un dépôt Github. Les dépôts privés et publics sont pris en charge.

Github via SSH

L'accès au référentiel SSH est configuré à l'aide de la syntaxe suivante pour l'emplacement

git@github.com : SecureCodeWarrior/ACookbook.git

Pour que cela fonctionne, le référentiel contiendrait le contenu d'un dossier de livres de recettes.

Il est également possible de configurer la branche et le sous-dossier du livre de recettes, par exemple dans la branche principale du sous-dossier du livre de recettes.

par exemple

• git@github.com : SecureCodeWarrior/sensei-blog-examples.git|master|.sensei

Une clé SSH doit être configurée pour les référentiels privés.

• https://github.com/settings/keys

Et la clé ne doit pas comporter de mot de passe.

Github via HTTPS

Il est également possible d'accéder aux dépôts publics via HTTPS, et la même syntaxe repo.git|branch|folder est utilisée, par ex.

Pour nos exemples de projets de blog :

• https://github.com/SecureCodeWarrior/sensei-blog-examples.git|master|.sensei

Pour notre ensemble d'exemples de protection de base, nous pouvons ignorer la branche et le sous-dossier car nous obtiendrons la branche principale par défaut et le fichier rules.sensei se trouve dans le dossier racine. :

• https://github.com/SecureCodeWarrior/cookbook-basic-protection-set

Zippé via HTTP (s)

Sensei peut également accéder à des livres de recettes compressés, via HTTP ou HTTPS.

par exemple si j'avais un serveur HTTP écoutant localement sur le port 8000

• http://localhost:8000/rules.sensei.zip

Le fichier zip du livre de recettes doit contenir le contenu d'un dossier de livres de recettes, par exemple le fichier rules.sensei.

Résumé du partage

Sensei prend en charge l'utilisation de plusieurs livres de recettes afin que chaque programmeur puisse disposer de recettes qui favorisent son apprentissage et sa productivité.

Plus important encore, nous savons que les équipes travaillent plus efficacement lorsque les connaissances sont partagées. Le fait de disposer de référentiels d'équipe partagés, par exemple pour un projet ou une bibliothèque spécifique, ou pour un ensemble partagé de modèles de migration, peut contribuer à améliorer la productivité de l'équipe et à codifier l'expérience de l'équipe.

Lorsqu'un livre de recettes est partagé, plusieurs équipes peuvent utiliser le même livre de recettes, ce qui peut également améliorer la collaboration entre les équipes issues de différentes disciplines, par exemple la sécurité des applications ou le développement.

Avec quatre principaux mécanismes de partage disponibles, Sensei propose, espérons-le, au moins une approche que vous pouvez utiliser pour améliorer la collaboration en matière de partage des connaissances.

---

Vous pouvez installer Sensei depuis IntelliJ en utilisant « Préférences \ Plugins » (Mac) ou « Paramètres \ Plugins » (Windows), puis recherchez simplement « Sensei Secure Code ».

Tous les articles du blog Sensei, le code et les recettes sont sur Github en :

•  https://github.com/SecureCodeWarrior/sensei-blog-examples