Altium NEXUSで外部SVNバージョン管理を使用する

This documentation page references Altium NEXUS/NEXUS Client (part of the deployed NEXUS solution), which has been discontinued. All your PCB design, data management and collaboration needs can now be delivered by Altium Designer and a connected Altium 365 Workspace. Check out the FAQs page for more information.

 

Parent page: 外部バージョン管理の使用

リポジトリの種類に応じて、次のような複数のプロトコルでアクセスできます。

  • 通常はローカルまたはネットワークベースのリポジトリ向けの、従来のファイルアクセス。
  • svnプロトコル。プレーンテキストまたはTCP/IPを使用します。あるいはセキュアなsvn+ssh相当。
  • http方式。一般にhttp上のWebDAVを使用します。あるいはセキュアなhttps相当。

Subversion(SVN)リポジトリは、PreferencesダイアログのData Management – Design Repositories page で接続され、必要に応じて作成されます。

設計プロジェクトでバージョン管理を使用する前に、いくつかの事前手順を完了しておく必要があります。要点は次のとおりです。

  • Altium NEXUSにVCS Provider – SVN Extensionがインストールされていることを確認します。これらは既定でインストールされていますが、ソフトウェアのExtensions and Updatesビューからアクセスできます。
  • Altium NEXUSのPreferencesダイアログのData Management – Version Controlページで、SVN Version Controlが有効になっていることを確認します。
  • SVN設計リポジトリを選択および/または作成し、Altium NEXUSとの接続を設定します。

SVN設計リポジトリの管理

SVN設計リポジトリは、Preferences ダイアログData Management – Design Repositories pageで管理します。このページでは、次のような複数の操作を実行できます。

  • Altium NEXUSに組み込まれたバージョン管理機能を使用して、新しいファイルベースのSVNリポジトリを作成する。
  • 既存のSVNリポジトリに接続する。
  • 定義済み各リポジトリの有効/無効(アクティブ状態)を制御する。

登録済み(つまり接続済み)の各リポジトリについて、次の情報が表示されます。

  • Name – リポジトリの分かりやすい名前。たとえば、そのリポジトリに保存されている設計プロジェクトを反映した名前にできます。この名前は、たとえばバージョン管理からプロジェクトを開く際に使用するDesign Repositoryを素早く選択するなど、ソフトウェア内の他の場所でも使用されます。
  • Activated – リポジトリがシステムで使用可能(有効)か、使用不可(無効)か。新規作成または接続したリポジトリは既定で有効になります。
  • Type – リポジトリの種類。SVNまたはGit
  • Repository – リポジトリのルートフォルダへのURL。
  • Status – Altium NEXUSとリポジトリ間の接続が成功しているか()否か()。接続に失敗している場合は、問題を示すコメントが表示されます。

新しいSVNリポジトリの作成

Altium NEXUS内からの新しいDesign Repositoriesの作成は、Preferences ダイアログData Management – Design Repositories pageから行います。ボタンをクリックし、関連するドロップダウンメニューからSVNを選択します。Create SVN Design Repository ダイアログが表示されます。

このダイアログでは、リポジトリのフォルダ場所と方式(接続プロトコル)、およびチェックアウトした設計ファイルのローカル接続名とターゲットフォルダパスを定義できる、さまざまな設定オプションが用意されています。なお、svn およびhttp のアクセス方式では、ホストシステムとそのアクセスに関する追加情報が必要です。

既定では、リポジトリ名はRepository 1になります。必要に応じて、より分かりやすい名前に変更してください。命名に制限はありません。
Repository Locationは、ハードドライブ上(個人利用向け)にも、ネットワーク上の場所(より広いチームでの共同利用向け)にも配置できます。

必要な設定をすべて指定したら、OKをクリックします。指定した場所にリポジトリが作成され、Altium NEXUSからそのリポジトリへの接続が確立されます。PreferencesダイアログのData Management – Design Repositoriesページに戻ると、Design Repositoriesの一覧にエントリが表示されます。

新規作成したSVN Design Repositoryの例。Altium NEXUS内ではLocal Repositoryとして表示されます。
新規作成したSVN Design Repositoryの例。Altium NEXUS内ではLocal Repositoryとして表示されます。

現在、Altium NEXUS内から直接作成できるのは、fileリポジトリアクセス方式のDesign Repositoriesのみです。別のアクセス方式(例:httpまたはhttpsによるネットワークアクセス)を使用するDesign Repositoryは、httpアクセス方式を実現するために必要なApache Webサーバーを同梱した外部SVNインターフェースツールを用いて、Altium NEXUSの外部でセットアップできます。あるいは、ネットワーク管理者にリポジトリをセットアップしてもらうか、ホスト型Subversionリポジトリを提供する多数のプロバイダーのいずれかを利用してください。その後、Altium NEXUS内から既存のリポジトリに接続できます。

既存のSVNリポジトリへの接続

共同作業環境では、複数ユーザーがアクセス可能な場所に、1つ以上のDesign Repositoriesがすでに作成されている場合があります。この場合、新しいリポジトリを作成して「車輪の再発明」をする必要はなく、必要な既存リポジトリに接続するだけで済みます。これは、リポジトリを一覧から削除してしまい、再度追加したい場合も同様です。

既存のリポジトリに接続するには、PreferencesダイアログのData Management – Design Repositoriesページでボタンをクリックし、関連するドロップダウンメニューからSVNを選択します。SVN Design Repository ダイアログが表示されます。Altium NEXUS内でリポジトリを参照するための名前を入力し、既定のチェックアウトパスを指定し、リポジトリアクセス方式とリポジトリのルートフォルダへのパスを指定します。リポジトリ内の特定のサブフォルダを指定することもできます。

必要な設定をすべて指定したら、OKをクリックします。接続が確立され、リポジトリを使用できるようになります。

既存のリポジトリへの接続(この例ではハードドライブ上のローカルリポジトリ)。既存のリポジトリへの接続(この例ではハードドライブ上のローカルリポジトリ)。

既存のリポジトリへの接続(この例ではサーバーインストール内の内部リポジトリ)。既存のリポジトリへの接続(この例ではサーバーインストール内の内部リポジトリ)。

リポジトリプロパティの編集

Design Repositoryのプロパティはいつでも編集できます。たとえば、Altium NEXUS内で表示・参照されるリポジトリ名を変更したい場合があります。あるいは、別のリポジトリにリンクするために接続設定を編集したい場合もあります。これを行うには、リポジトリ一覧(Preferences ダイアログのData Management – Design Repositoriesページ)で対象リポジトリのエントリを選択し、ボタンをクリックします。SVN Design Repositoryダイアログ(またはGit Repositoryダイアログ)が表示され、必要に応じて変更できます。

リポジトリからの切断

Design Repositoryから切断するには、一覧でそのエントリを選択し、ボタンをクリックします。リポジトリは接続済みDesign Repositoriesの一覧から削除されます。リポジトリ自体は削除されず、システムから切断されるだけです。再び使用するには、接続し直してください。

Design Repositoryの使用を、一覧から完全に削除せずに無効化するには、関連するActivated optionを無効にします。
管理コンテンツサーバーへのサインインによって追加されたDesign Repositoryを削除した場合でも、再度接続できます。あるいは、より迅速な方法として、Preferencesダイアログを閉じてからサーバーからサインアウトし、再度サインインします。その後、Preferences ダイアログのData Management – Design Repositoriesページに再びアクセスすると、該当するリポジトリが再度表示されます。

SVN設計リポジトリの使用

いったん定義すると、SVN Design Repositoryは「接続済み」であるため、プロジェクトをそのリポジトリに追加することも、そのリポジトリから既存プロジェクトを開くことも容易になります。リポジトリのパスを覚えたり、参照メニューで階層をたどって選択したりする代わりに、現在接続していて使用可能(有効)になっているすべてのDesign Repositoriesの便利な一覧から、必要なリポジトリを選ぶだけで済みます。

設計リポジトリに初めてアクセスする際は、ログイン資格情報を入力する必要があります。たとえば、外部VCSサーバーのログイン資格情報(例:VisualSVN Server上にある設計リポジトリの場合)です。

一般に、プロジェクトファイルは、ProjectsまたはStorage Managerパネルのコマンドを使用してバージョン管理リポジトリに追加できます。これは、追加対象としてファイルを登録し、その後それらのファイルをVCSにコミットする手順を含みます。

以下に示す手順では、手元で使いやすいProjectsパネルを使用していますが、Storage Managerパネルの方がVCSの詳細情報とオプションがより多く提供される点は注記しておきます。

ローカルプロジェクトをSVN Design Repositoryに追加する

(現在バージョン管理下にない)ローカルの設計プロジェクトをDesign Repositoryに追加する手順は簡単です。プロジェクトを開いた状態で、Projects panelまたはStorage Manager panelのいずれかからAdd Project Folder To Version Controlコマンドを使用します。Add to Version Control ダイアログが表示されます。このダイアログ上部のフィールドには、接続済みかつ有効化されているすべてのDesign Repositoriesのドロップダウン一覧が表示されます。必要なリポジトリを選択します。

ボタンをクリックすると、Preferences ダイアログData Management – Design Repositories pageにすばやくアクセスできます。別のSVNリポジトリに接続する必要がある場合や、新規作成する必要がある場合に使用します。
Altium NEXUSがAltium 365 Workspaceに接続されている場合、Add to Version Control ダイアログは、選択したプロジェクトをオンラインで利用可能にする、つまりWorkspaceのネイティブVCSに追加することを提案します。このSVNリポジトリにプロジェクトを追加するには、ダイアログ上部のドロップダウンメニューから接続済みのSVNリポジトリを選択して続行します。

選択したDesign Repository内のフォルダ階層は、ダイアログのFolders領域に表示されます。設計ファイルを追加する既存フォルダを指定するか、 ボタンを使用して新しいフォルダを作成します。後者の場合、リポジトリのフォルダ階層内の指定位置に、プロジェクトを含むソースフォルダ名を付けたフォルダが追加されます。

ローカルの設計プロジェクトをローカルの設計リポジトリに追加する。
ローカルの設計プロジェクトをローカルの設計リポジトリに追加する。

をクリックして設定を確定します。するとダイアログにソースフォルダから抽出されたファイルエントリが表示され、プロジェクトを構成するファイルが選択された状態になります。必要に応じてチェックボックスで、含めるファイルを有効/無効にしてください。 を選択して選択内容を確定します。なお、Projects パネル内のファイルエントリはステータスがScheduled for addition)になっているはずです。これは、VCSがそれらのファイルをバージョン管理への追加対象として登録し、VCSリポジトリへチェックイン(Commit)できる状態になっていることを示します。

追加予定としてスケジュールされたファイル追加予定としてスケジュールされたファイル

プロジェクトのコミット

ステータスがScheduled for addition)のファイルは、Commit時にバージョン管理および設計リポジトリへ追加されます。実行するには、Projectsパネルの右クリックメニューからVersion Control » Commit Whole Projectコマンドを選択して処理を開始します。

Commit Whole ProjectコマンドCommit Whole Projectコマンド

続いて表示されるAdd to Version Controlダイアログでは、バージョン管理の対象として含める個々のプロジェクトファイルを選択解除(または追加選択)できます。コメントも追加でき、これは次回のVCSリビジョンに含まれます。

バージョン管理下に追加する特定ファイルの選択バージョン管理下に追加する特定ファイルの選択

その後、プロジェクトとその構成設計ドキュメントがVCSリポジトリへコピーされ、新しいリビジョンとして登録されます。同時に、Altium NEXUSの各パネルにおけるファイルのステータスはNo Modification)に変更されます。

いったんプロジェクトをバージョン管理に追加すると、以降は単体のAdd to Version ControlおよびCommitコマンドを使用して、個別にファイルを追加してCommitできます。同様に、Remove from Version Controlコマンドを使えば、特定ファイルをバージョン管理から個別に削除(ただしローカルの作業プロジェクトには保持)できます。

新しいバージョン管理プロジェクトの作成

新しいバージョン管理プロジェクトを作成する際、Create Project ダイアログRepository フィールドには、接続され有効化されているすべてのDesign Repositoriesのドロップダウンリストが表示されます。必要なリポジトリを選択してください。

新しいバージョン管理設計プロジェクトの作成 – 定義済みのDesign Repositoriesはすべて使用可能。
新しいバージョン管理設計プロジェクトの作成 – 定義済みのDesign Repositoriesはすべて使用可能。

Create ProjectダイアログのLocal Storageオプションは、プロジェクトの作業コピーを保存する場所を定義します。これらのファイルがAltium NEXUSで開かれて編集され、編集完了後に新しいリビジョンとしてリポジトリへCommit(チェックイン)されます。

SVN Design Repositoryからバージョン管理プロジェクトを開く

Design Repository内にあるバージョン管理設計プロジェクトを開くことも、同様に簡単です。File » Checkoutコマンドを使用すると、Check Out ダイアログが表示されます。Check out fromフィールドで、接続され有効化されているすべてのDesign Repositoriesのドロップダウンリストから必要なリポジトリを選択します。

別のリポジトリに接続する必要がある場合は、 ボタンをクリックして、Preferences ダイアログData Management – Design Repositories pageへすばやくアクセスできます。

選択したDesign Repository内のフォルダ階層は、ダイアログのFolders領域に表示されます。この領域を使用して、リポジトリからチェックアウトする正確なフォルダを指定します。

Check out toフィールドで、指定したフォルダ内容をチェックアウトする先を指定します。ここがローカルのサンドボックス領域です。

指定したDesign Repositoryから既存のバージョン管理設計プロジェクトを、管理された手順で簡単にチェックアウトできます!
指定したDesign Repositoryから既存のバージョン管理設計プロジェクトを、管理された手順で簡単にチェックアウトできます!

SVNプロジェクトのファイルをロックする

SVN VCSはファイルロックをサポートしており、ロックされたファイルには他のユーザーが変更をCommitできません。SVN VCSでプロジェクトの設計ファイルをロックするには、Projects パネルでそのファイルを右クリックし、History & Version Control » Lock コマンドを選択します(またはStorage Managerパネル内のファイルの右クリックメニューからLockコマンドを選択します)。ロックされたファイルは、ProjectsおよびStorage Managerパネルでアイコン付きで表示されます。

そのファイルは自分または別のユーザーによってロックされています。自分がロックした場合、そのファイルは(強制的にアンロックされない限り)他のユーザーがリポジトリ上の新しいリビジョンへ更新できません。ロックされたファイルを示すアイコンは1種類ですが、付随するテキストによって、誰がロックしたか(Locked by meまたはLocked by someone else)が示されます。VCSテキストは、たとえばModified and locked by meのように、複合条件も示します。

AI-LocalizedAI で翻訳
問題が見つかった場合、文字/画像を選択し、Ctrl + Enter キーを押してフィードバックをお送りください。
Content