Migration guide from APIOps Toolkit to APIOps CLI

オープン
#133 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
45/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
静か
技術スタック
github-actions

調査の方向性

提案されたコンテンツセクションを初期チェックリストとして使用し、Toolkit-to-CLI の概念とアーティファクトマッピングから始めて、設定、CI/CD、および移行手順を確認します。#120 の Copilot 支援による設定プロンプト、新しい機能、トラブルシューティングを含めます。完了とは、ガイドが顧客に完全で実行可能な移行パスを提供することです。

索引モデルが issue の本文から書いたものです。

説明

Enhancement P2

Summary

Create documentation (and/or a guided walkthrough) that helps customers migrate from the existing APIOps Toolkit to APIOps CLI.

Problem

Customers currently using APIOps Toolkit need a clear path to adopt APIOps CLI. Without a migration guide, they face uncertainty about:

  • How their existing extracted artifacts map to the new CLI's format
  • How to recreate their CI/CD pipelines
  • How to migrate their configuration (filters, overrides)
  • What new capabilities they gain (e.g., Copilot-assisted configuration setup per #120)

Proposed Content

1. Conceptual Mapping
  • Side-by-side comparison of Toolkit vs CLI concepts (extractor → apiops extract, publisher → apiops publish, etc.)
  • Differences in artifact format and directory structure
2. Step-by-Step Migration
  • How to initialize a new repo with apiops init
  • How to migrate existing extracted artifacts (or re-extract from scratch)
  • How to convert Toolkit configuration files to CLI configuration format
  • How to update CI/CD pipelines (GitHub Actions / Azure DevOps)
3. Leveraging New Features
  • Using the interactive Copilot-assisted configuration prompt (#120) to generate new configuration files from migrated artifacts
  • New capabilities not available in Toolkit (incremental publish, etc.)
4. FAQ / Troubleshooting
  • Common migration pitfalls
  • Breaking changes between Toolkit and CLI

Related

  • #120 — Interactive configuration prompt (relevant to migration step where users set up new config files)
主要言語
TypeScript
スター
29
フォーク
10
平均マージ
1日 14時間
マージ済み PR(30日)
22

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

Azure/apiops-cli のほかの issue

Azure/apiops-cli の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。