チーム内でのクックブックの共有

チーム内でのクックブックの共有

ある人がコードの品質や生産性を向上させるためにSenseiレシピを作成した場合、クックブックを共有することでチームの全員が恩恵を受けることができます。

Senseiは、料理本を共有するためのさまざまなメカニズムを提供しています。

• バージョン管理下のプロジェクトにクックブックを保存
• クックブックを共有フォルダーに保存する
• クックブックを Github に保存する
• HTTP (s) 経由で圧縮されたファイル

Senseiはクックブックを共有することで、チームが協力して知識を共有できるよう支援します。このコラボレーションは、コミュニケーションを改善し、合意されたコード品質アプローチを組み込むのに役立ちます。

たとえば、料理本の共有:

• チームメンバー同士が役に立つレシピを共有するのに役立ちます。
• チームリーダーが合意されたコーディングプラクティスを体系化し、ジュニアスタッフ向けにサポートします。これにより、一般的な違反を特定し、合意されたバージョンを迅速に修正できます。
• チーム間の協力の強化を促進します。たとえば、AppSecチームがコード内の問題を浮き彫りにするレシピを作成し、開発チームがクイックフィックスを書くことができます。

次のいくつかのセクションでは、それぞれの共有メカニズムを実装する方法について説明します。

バージョン管理下のプロジェクトにクックブックを保存

プロジェクト.sensei フォルダは、クックブックファイルを作成する際のデフォルトオプションです。

• `プロジェクト://.sensei`

すべてのクックブックとレシピは、プロジェクトの.senseiフォルダに保存されます。

共有する最も簡単な方法は、プロジェクトの.senseiフォルダをバージョンコントロールに追加することです。

これで、.sensei フォルダーは、プロジェクトに関連する他の共有コードアーティファクトと同様に管理できます。クックブックは YAML 設定として保存されるため、コミットやレビューのプロセス中に簡単にマージできます。

これがパブリックセンセイ・ブログ・サンプル・プロジェクトで採用されたアプローチです。

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

.sensei フォルダーには、すべてのレシピが記載されたクックブックが含まれており、リポジトリをクローンするユーザーなら誰でも使用できます。

クックブックを任意のフォルダに保存

チームは、中央の場所に保存されているクックブックを使用することもできます。

クックブックを共有書き込み権限のあるフォルダに保存すると、チーム全員がレシピを更新したり、作業中のプロジェクトにインポートしたりできます。

場所はディレクトリパスに設定されます。

レシピを Github に保存する

Senseiは、Githubリポジトリに保存されているレシピにもアクセスできます。プライベートリポジトリとパブリックリポジトリの両方がサポートされています。

SSH 経由の Github

SSH リポジトリへのアクセスは、ロケーションの次の構文を使用して設定されます

git@GitHub.com: SecureCodeWarrior/a Cookbook.git

これを機能させるには、リポジトリにクックブックフォルダーの内容が含まれている必要があります。

また、クックブックのブランチとサブフォルダー（例：マスターブランチ、クックブックサブフォルダー）を設定することもできます。

例:

• git@GitHub.com: SecureCodeWarrior/sensei-Blog-examples.git|master|.sensei

プライベートリポジトリには SSH キーを設定する必要があります。

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

また、キーにはパスフレーズを含めないでください。

HTTPS 経由の Github

HTTPS 経由でパブリックリポジトリにアクセスすることも可能で、同じ repo.git|branch|folder 構文が使用されています。例:

ブログサンプルプロジェクトの場合:

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

Basic Protection のサンプルセットでは、ブランチとサブフォルダーは無視してかまいません。デフォルトで master ブランチが取得され、`rules.sensei` ファイルはルートフォルダーにあるからです。:

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

HTTP (s) 経由で圧縮

先生は、圧縮されたクックブックにHTTPまたはHTTPS経由でアクセスすることもできます。

たとえば、HTTPサーバーがポート8000でローカルでリッスンしている場合

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

zip クックブックファイルには、rules.sensei ファイルなどのクックブックフォルダーの内容が含まれている必要があります。

共有概要

Senseiは、個々のプログラマーが自分の学習と生産性をサポートするレシピを作成できるように、複数のクックブックの使用をサポートしています。

さらに重要なのは、知識が共有されるときにチームが最も効果的に機能することがわかっていることです。特定のプロジェクトや特定のライブラリ、または一連の移行パターンを共有するチームリポジトリを共有することは、チームの生産性を高め、チームの経験を体系化するのに役立ちます。

クックブックを共有すると、複数のチームが同じクックブックを使用できます。これにより、AppSecなどのさまざまな分野のチーム間のコラボレーションが改善され、開発にもつながります。

Senseiには、4つのコア共有メカニズムが用意されているので、知識共有に関するコラボレーションを増やすために使用できるアプローチが少なくとも1つあることを願っています。

---

「環境設定\ プラグイン」(Mac) または「設定\ プラグイン」(Windows) を使用してIntelliJ内からSenseiをインストールし、「senseiセキュアコード」を検索するだけです。

Senseiのブログ投稿コードとレシピはすべて、Githubの次の場所にあります。

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