16. インテグレーション

Spotter の機能を強化し、ワークフローを合理化し、開発プロジェクトを効率的に管理します。Spotter は作業環境とシームレスに統合されます。

GitLab と GitHub の統合により CI/CD パイプラインに組み込んだり、Spotter Visual Studio Code 拡張機能を使用してお気に入りのコードエディターで使用したり、

追加の機能を発見したりすることもできます。

GitHubアクション

Steampunk Spotter GitHub Action を使用すると、GitHub CI/CD ワークフロー内で Ansible コンテンツを簡単にスキャンできます。

xlab-steampunk/spotter-github-actions@<version>CI/CD パイプラインを設定するときは、 YAML ワークフローファイルのステップとして名前を使用して、
Steampunk Spotter GitHub アクションを指定します。

1. GitHub に新しい Git リポジトリを作成
たとえば、「spotter-github-ci」という名前を付け、プライベートに設定されていることを確認します。README ファイルを使用してリポジトリを初期化できます。
2. スキャンするプレイブックを作成
「ファイルの追加」アイコンをクリックし、「新しいファイルの作成」を選択して「playbook.yaml」という名前を付け、プレイブックのコンテンツを追加して変更をコミットします。
3. API トークン認証を構成
Spotter アプリに移動し、ユーザー設定を開いて「API トークン」をクリックし、「github」という名前の新しいトークンを生成します。
生成されたトークンをコピーして、GitHub リポジトリに戻ります。「設定」をクリックし、リポジトリ設定で「シークレットと変数」を検索して展開し、アクションを選択します。
「新しいリポジトリシークレットの追加」を選択します。「SPOTTER_API_TOKEN」という名前を付け、コピーした API トークンを貼り付けます。
4. Ansible コンテンツをスキャンするように CI/CD を構成
「.github/workflows」ディレクトリに「.spotter-ci.yml」という YAML ファイルを作成し、この CI 構成を YAML ファイルに貼り付けます。
yaml  
  name: Steampunk Spotter  
  on: push   
  jobs:   
    spotter-scan:   
      runs-on: ubuntu-latest   
      steps:   
      - name: Checkout repository   
        uses: actions/checkout@master  
   
      - name: Scan Ansible content   
      uses: xlab-steampunk/spotter-action@master  
      with: paths: .   
      include_values: true   
      include_metadata: true   
      ansible_version: 2.14   
      env: SPOTTER_API_TOKEN: ${{ secrets.SPOTTER_API_TOKEN }}
        
「spotter-scan」を実行してプレイブックをスキャンし、変更をコミットして、CI/CD パイプラインの実行が開始されるかどうかを確認します。
5. スキャン結果を取得
スキャン中に見つかったすべてのエラー、警告、ヒントを表示します。
書き換え機能を除き、Spotter CLI と同じように他の Spotter 機能を使用します。
より詳細な手順と例については、 GitHub Marketplace の Steampunk Spotter ページと Steampunk Spotter GitHub Action リポジトリをご覧ください。

GitLab

Steampunk Spotter を GitLab と統合すると、CI/CD パイプライン内でスキャン結果をユニットテストレポートとして簡単に表示できます。
この合理化されたプロセスにより、失敗したチェックをすばやく特定できます。
コードの健全性と品質を追跡しながら、シームレスなエクスペリエンスをお楽しみください。

1. 新しい Git リポジトリを作成し、リポジトリに「spotter-gitlab-ci」という名前を付け、非公開のまま README ファイルで初期化することを選択します。

2.スキャンする新しい Ansible Playbook を作成します。プラスアイコンをクリックして「新しいファイル」を選択し、YAML ファイルに「playbook.yaml」という名前を付けて、ファイルにプレイブックを貼り付けます。

3. API トークン認証を構成する: Spotter アプリを開き、ユーザー設定に移動して「API トークン」をクリックし、「gitlab」という名前の新しいトークンを生成し、
生成された API トークンをコピーします。GitLab リポジトリに戻り、設定にアクセスして「CI/CD」に移動し、「変数」を検索して「変数の追加」を選択します。「SPOTTER_API_TOKEN」という名前を付け、API トークンをフィールドに貼り付けます。

4. CI/CDを設定して実行する: spotter scan CLIコマンドを–format junit_xml –outputとともに使用するGitLab 内の指定された場所に JUnit XML レポートを作成するオプションの引数。

5. スキャン結果を取得: GitLab は、成功したチェックには緑のチェックマーク、失敗したチェックには赤い十字としてチェック結果を表示します。書き換え機能を除き、Spotter CLI と同じように他の Spotter 機能を使用します。

VSコード拡張機能

Steampunk Spotter と Visual Studio Code の統合により、Ansible コンテンツをスキャンし、問題を特定し、好みのコーディング環境内で直接プレイブックを改善できます。
またワークフローを合理化し、開発速度を速め、生産性を高めます。

すべての Spotter 機能をお気に入りのコードエディターに導入するだけでなく、Spotter VSC 拡張機能では、専用のAssisted Playbook Writing機能も提供されます。

Visual Studio Marketplace または Open VSX Registryから拡張機能をインストールするだけです。
通常 VS Code で使用するコンソールにSteampunk Spotter ユーザーアカウントと Steampunk Spotter CLI がインストールされている必要があります。
その後は準備完了で、スキャンを開始できます。