AccuRev for Developers BETA
Do all of your common daily development tasks right here. Add new files, modify existing files then keep and promote your changes to the AccuRev server from one UI. You can also diff your changes against the backing stream or the most recent version of the file. Additionally you can resolve conflicts before promoting your changes. If your organization uses change packages (AccuWork Issues) you can promote your changes against an issue here too.
@ja For Japanese version of this document find the section beginning with @ja below the English version.
(日本語版へ移動)
Requirements
- AccuRev Server and Client 7.6 and higher.
Note: For full functionality always use the latest release of AccuRev Server.
- AccuRev client installed.
- Visual Studio Code version 1.74 and higher.
Quick Start
- Install this extension and already have the AccuRev Client 7.6 or higher installed.
- Open an AccuRev workspace within Visual Studio Code using File - Open Folder.
- If necessary you will be prompted to login to AccuRev.
- Start working with your workspace and files.
Source Control Viewlet - AccuRev Features
The viewlet will display a value on the Source Control (SCM) icon in the Activity Bar indicating the number of changes pending. Select the Source Control icon to switch to the SCM viewlet. Your AccuRev changes will be listed in one of four sections within the Source Control section. You will only see files that have changes requiring action from you. If you have not made any changes then the Source Control section will be empty.
You can update your workspace from the Source Control Repositories section then select the workspace you wish to update. Click the U which will update your workspace after you click on it.
You can know and update the workspace if there are incoming changes from backing stream from the Source Control Repositories and also in Source Control Viewlet. New option I has been added to Source Control viewlet to notify about 'Incoming changes' into the AccuRev workspace from the backing stream . The icon is enabled and clickable if there are incoming changes and workspace is not up to date, disabled otherwise. On clicking the icon, a dialog will appear mentioning about the count of incoming changes with Yes/Cancel button asking to update the workspace
Workspace Changes
Once a change has been saved (kept) with AccuRev or a file is added to AccuRev the change has permanently become part of your workspace. These files currently exist only in your workspace. They have not been promoted or pushed to a parent stream.
An icon to Promote All Changes is available in the Workspace Changes section header.
Local Changes
Local Changes are changes to your workspace that have not yet been saved (kept) with or added to AccuRev.
Files that have been modified or are new to the workspace appear under this heading. Each file will have a status indicator such as E for External or M (blue) for Modified.
Overlap Changes
Files that have been changed in the parent hierarchy will appear as overlap changes with a status indicator of O.
Files in this section will require a merge before they can be pushed or promoted to the parent stream. Overlap changes need to be handled singularly.
Missing Workspace Files
Files that have been deleted from the workspace but are present in the backing stream will appear here. This can happen if you delete the file from Visual Studio Code, from the file system but not from within AccuRev. You can restore the file to the workspace by right-clicking it then select Restore Missing Element (Populate). To remove the file from the workspace permanently select Remove from Accurev (Defunct) from the right-click menu.
Files in this section have a status of M (red) for Missing.
Work Items (AccuWork Issues)
Work Items which may also be known as Change Packages or AccuWork Issues are listed in the section entitled Work Items. If you are using Change Packages a list of available issues will display in this section.
Work Items allow you associate your changes to one or more files by assigning your changes to a Work Item when you Promote your changes. This makes it easy to track feature changes or bug fixes by grouping all files related to the change together as part of the Promote process. If your organization uses Change Packages you will be prompted to select a Work Item to promote your changes against.
This section has some tools to help manage the list of work items:
- Search allows you to search through the Work Items displayed. The search is case-insensitive. When you click on the search icon a small popup window appears. Enter your search string. Matches for your search string will be highlighted. Click the filter icon to show only Work Items which match your search string. Click the X to dismiss the search popup and clear the filter.
- Refresh Work Items allows you to check for new Work Items on the server.
- You can also toggle between Show All Work Items and Show Selected Work Item.
When working in your workspace on a single Work Item select it then choose Show Selected Work Item. You will then only see the Work Item that you are currently addressing. When you have finished your work and are ready to Promote your changes you will not have to hunt through the list of available Work Items to select the right Work Item to Promote against. When the work for this item is complete and promoted stoggle back to Show All Work Items to find the next task you need to work on then repeat the process.
By default the Work Items are shown with the Issue number field followed by the shortDescription field. If you are using the default schema in AccuWork both of these fields will be available. You can customize the Work Items display by changing the title and by adding additional fields. Adding more fields will make the issues expandable so that you can see all fields you have specified.
- To change or add a title to your Work Items
- Open the Command Palette: select View - Command Palette from the menu or via Ctl-Shift-P
- Select command AccuRev: Select AccuWork Issue field to display as Work Item title
Enter accurev in the input filter field to display only AccuRev options
- Choose the field you want to use for the title of the issue
To reset to the default, open the ac_vsc_ws.cnf file within the .accurev directory of your workspace folder. Comment the line containing CPK_ISSUE_TITLE by inserting a # at the beginning of the line.
- To display additional fields on Work Items
- Open the Command Palette: select View - Command Palette from the menu or via Ctl-Shift-P
- Select command AccuRev: Select AccuWork Issue fields to display
- Choose the fields you want to display by checking each item. To select all items check the top checkbox.
To remove all additional fields, open the ac_vsc_ws.cnf file within the .accurev directory of your workspace folder. Comment the line containing CPK_FIELDS by inserting a # at the beginning of the line.
To change the order of the fields manually edit the ac_vsc_ws.cnf file line containing CPK_FIELDS to reflect the order you want.
File Actions
| Action |
Description |
| Add To AccuRev |
The Add to AccuRev command is available for External files only. External files display in the Local Changes section with an attribute of E. To add a file to AccuRev right-click the file then choose Add To Accurev or simply click on the + icon that displays when hovering on an External file. Enter a comment then press Enter to add the file to your workspace. The file is added to AccuRev and kept which moves the file to the Workspace Changes. |
| Keep My Changes |
The Keep My Changes command saves your changes in AccuRev. Keep My Changes is available for Modified files (attribute of M in blue). You may Keep files several times before promoting or pushing your changes to the parent stream. Once a file is kept it moves to the Workspace Changes section and is ready to be Promoted. To save (keep) changes to a file in AccuRev right-click the file then choose Keep My Changes or simply click on the + icon that displays when hovering on a Modified file. |
| Promote |
The Promote command moves your Workspace Changes to the backing or parent stream. If your organization uses Change Packages you will need to select a Work Item to Promote against. Promote is available for files in Workspace Changes. If your organization uses Change Packages you will be prompted to select aWork Item if you have not already selected one in the Work Items section. |
| Revert To |
The Revert command allows you to cancel changes you made on files in your workspace. For Workspace Changes, files that have already been kept at least once in your workspace you can Revert to Basis. This removes any changes made in your workspace and restores the file version from the backing stream.
For Local Changes you can either Revert to Basis or Revert to Most Recent Version. Revert to Most Recent Version will discard unkept changes leaving you with the most recently kept version within your workspace. This version could be the basis version if you have not kept any changes to the file in your workspace. |
| Merge |
If changes you have made in a file conflict with the current version of the file in the backing or parent stream the file will display in the Overlap Changes section.
To resolve the conflict right-click the file then select Merge. At this point the AccuRev Merge window will display. Resolve the conflicts then save your results to complete the merge. A prompt will appear to allow you to Accept Merge or to Cancel the merge. Refer to AccuRev Help for details on how to use the merge UI. |
| Diff Against |
Diff Against allows you to use the Visual Studio Code Diff Editor to compare two versions of a file. Refer to Visual Studio Code Help for details on how to select and use the diff editors.
Diff Against Backed Version compares your workspace file version with the one in the backing or parent stream.
Diff Against Most Recent Version compares your workspace file version with the most recently kept version. If you have not kept any changes the most recently kept version will be the backed version of the file. |
| Remove From AccuRev (Defunct) |
If you want to remove a file you can delete the file from the file system. In the SCM viewlet the file you deleted will appear under Missing Workspace Files where you will have the option to Remove From AccuRev (Defunct). This command marks the file for deletion from Accurev and moves it to Workspace Changes with a status of D. Once you promote the defunct file it will be removed from the AccuRev backing stream. |
| Restore Missing Element (Populate) |
If you deleted a file in error or you just want to restore the file, you can select Restore Missing Element (Populate) from the SCM viewlet to reload the file from AccuRev. |
| Open File |
Open the file in the editor. |
File States
Files in your workspace can have the following states which are indicated by a letter to the right of the file name in the Source Control section.
| Symbol |
Attribute |
Description |
| K |
Kept |
File that has been saved in AccuRev and is under source control but the version is only available from within your workspace |
| M (blue) |
Modified |
File has been saved locally in your workspace but has not been saved in AccuRev |
| E |
External |
File in your workspace that has not been added to AccuRev |
| D |
Defunct |
File has been marked for removal from AccuRev. It will be removed once the file is promoted to the backing stream |
| O |
Overlap |
File in the backing stream has changed since you last updated your workspace and requires a merge before you can promote your changes |
| M (red) |
Missing |
Files that have been deleted from your workspace which still exist in the backing stream |
Login Prompt
- If you have not logged in to AccuRev or if your session expires a Login prompt will appear. Select the server you want to login to then press Enter. Enter your user name then your password when prompted. If login fails you will be prompted to login again.
You can display the AccuRev login prompt at any time by using Shift-Ctl-P or menu View - Command Palette then select AccuRev: Login to AccuRev.
GitServer repos
- User can work with GitServer repos from VSCode by having AccuRev VSCode extension.
- If Change Package triggers are configured, ACCUWORK issues will be loaded under WORK ITEMS section. Issue being worked upon needs to be selected while performing 'push'.
Known Issues
- To select an issue or Change Package select the issue number line and not a supplemental line which displays if you have customized the display of the CPK Issues (see CPK Issues for details).
- Ability to do AccuRev rename of files and folders.
Change Log
See the Changelog for details about the changes in each version.
@ja
AccuRev for Developers BETA
この拡張機能を使って、すべての日々の一般的な開発作業を行うことができます。 UI 上から、新しいファイルを追加したり、既存のファイルを変更して、AccuRev サーバーに変更をキープおよびプロモートできます。 また、ファイルの親ストリームのバージョンや最新のバージョンと変更を比較できます。 さらに、変更をプロモートする前に、競合を解決することもできます。 変更パッケージ (AccuWork 課題) を使用している場合には、課題に対して変更をプロモートすることもできます。
要件
- AccuRev サーバーおよびクライアント 7.6 以降
メモ: すべての機能を利用するには、最新の AccuRev サーバーを使用してください。
- AccuRev クライアントのインストール
- Visual Studio Code バージョン 1.74 以降
クイックスタート
- AccuRev クライアント 7.6 以降をインストールしたマシン上の Visual Studio Code に、この拡張機能をインストールします。
- Visual Studio Code の [ファイル] > [フォルダーを開く] を使って、AccuRev ワークスペースを開きます。
- 必要に応じて、指示に従って AccuRev にログインします。
- ワークスペース上のファイルに対して作業を開始します。
ソース管理ビューレット - AccuRev の機能
ビューレットによって、アクティビティ バーにソース管理 (SCM) アイコンが表示され、保留中の変更数が表示されます。 ソース管理アイコンを選択すると、SCM ビューレットに切り替わります。 ソース管理 セクションは 4 つのセクションに分かれており、AccuRev の変更はいずれかのセクションに表示されます。 ユーザーからのアクションが必要な変更を持つファイルだけがここに表示されます。 何も変更していなければ、ソース管理セクションは空になります。
ソース管理リポジトリ セクションでは、更新したいワークスペースを選んで更新できます。 U アイコンをクリックすると、ワークスペースが更新されます。
親ストリームに変更がある (Incoming Changes) ことを ソース管理リポジトリ や ソース管理ビューレット で確認してワークスペースを更新できます。ソース管理ビューレットに新しい 'I' オプションが追加され、AccuRev ワークスペースに対する親ストリームからの 'Incoming Changes' についての情報が通知されます。親ストリームに変更があり (Incoming Changes)、ワークスペースが最新でない場合にのみ、アイコンは有効でクリック可能になり、それ以外の場合は無効になります。アイコンをクリックすると、ダイアログが開き Incoming Changes の数についての情報が表示されます。 ユーザーは、ワークスペースを更新する場合は [はい] ボタンを、しない場合は [キャンセル] ボタンをクリックします。
ワークスペースの変更
ローカルの変更
オーバーラップする変更
存在しないワークスペース ファイル
親ストリームに存在し、ワークスペースから削除されたファイルは、ここに表示されます。 この状況は、Visual Studio Code 上やファイル システム上でファイルを削除し、AccuRev 上では削除していない場合に発生します。 ファイルを右クリックして [存在しない要素の復元 (ポピュレート)] を選択すると、ファイルをワークスペースに戻すことができます。 ファイルをワークスペースから完全に削除する場合は、右クリック メニューから [AccuRev から削除 (デファンクト)] を選択します。
このセクションのファイルは、存在しないことを示すステータスのマーク M (赤) が表示されます。
作業項目 (AccuWork 課題)
作業項目は、変更パッケージまたは AccuWork 課題であり、作業項目 セクションに表示されます。 変更パッケージを使用している場合は、利用可能な課題の一覧がこのセクションに表示されます。
作業項目を使うと、変更をプロモートするときにその変更を作業項目に割り当てることで、複数のファイルへの変更と関連付けることができます。 これにより、プロモート処理の一環として作業項目に関連付けられたすべてのファイルがグループ化されるため、機能の変更やバグ修正のトラッキングが容易になります。 変更パッケージが有効化されている場合、変更をプロモートする際に、作業項目を選択するプロンプトが表示されます。
このセクションには、作業項目のリストを管理するのに役立つツールが提供されています。
- 検索アイコンを使って、表示されている作業項目を検索できます。 検索では大文字小文字は区別されません。 検索アイコンをクリックすると、小さいポップアップ ウィンドウが表示されます。 検索文字列を入力します。有効な検索条件を入力してください。 検索文字列に一致する作業項目が強調表示されます。 フィルター アイコンをクリックすると、検索文字列に一致する作業項目だけが表示されます。 X をクリックすると検索ポップアップが閉じられ、フィルターが解除されます。
- リフレッシュ アイコンを使って、サーバー上の新しい作業項目を確認できます。
- [すべての作業項目の表示] と [選択した作業項目の表示] を切り替えることもできます。
単一の作業項目に対してワークスペースで作業を行う場合は、その作業項目を選択し、[選択した作業項目の表示] に切り替えます。 これにより、現在対応中の作業項目だけが表示されるようになります。 作業が完了し、変更をプロモートするときに、プロモートに対する正しい作業項目を、多くの作業項目の中から探し出す必要がなくなります。 この項目に対する作業が完了したら、[すべての作業項目の表示] に切り替えて次に作業する必要のあるタスクを探し出し、作業を繰り返します。
デフォルトでは、作業項目は課題番号 (issueNum) フィールドと概要 (shortDescription) フィールドの値が表示されます。 AccuWork のデフォルト スキーマを使用している場合は、両方のフィールドが利用できます。 タイトルを変更したり、その他のフィールドを追加することによって、作業項目の表示をカスタマイズできます。 その他のフィールドを追加すると、課題が展開可能になり、指定したすべてのフィールドが表示されます。
- 作業項目のタイトルを変更するには：
- メニューから [表示] > [コマンド パレット] を選択するか、Ctl-Shift-P を押下してコマンド パレットを開きます。
- 次のコマンドを選択します： AccuRev: 作業項目のタイトルとして表示する AccuWork 課題フィールドの選択
入力フィルター フィールドに accurev を入力すると、AccuRev コマンドだけが表示されます。
- 課題のタイトルとして使用するフィールドを選択します。
デフォルト値にリセットするには、ワークスペース フォルダーの .accurev ディレクトリにある .ac_vsc_ws.cnf ファイルを開きます。CPK_ISSUE_TITLE を定義する行を探し、行の先頭に # を挿入してコメントアウトします。
- 作業項目のその他のフィールドを表示するには：
- メニューから [表示] > [コマンド パレット] を選択するか、Ctl-Shift-P を押下してコマンド パレットを開きます。
- 次のコマンドを選択します： AccuRev: 表示する AccuWork 課題フィールドの選択
- 表示したい項目をチェックして選択します。 一番上にあるチェックボックスをチェックすると、すべての項目が選択されます。
すべてのその他のフィールドを削除するには、ワークスペース フォルダーの .accurev ディレクトリにある .ac_vsc_ws.cnf ファイルを開きます。CPK_FIELDS を定義する行を探し、行の先頭に # を挿入してコメントアウトします。
フィールドの順番を変更するには、.ac_vsc_ws.cnf ファイルを開き、CPK_FIELDS を定義する行を手動で編集してフィールドの順番を変更します。
ファイル アクション
| アクション |
説明 |
| AccuRev に追加 |
[AccuRev に追加] コマンドは、外部ファイルに対してのみ利用可能です。 外部ファイルは、ローカルの変更セクションに属性 E と共に表示されます。 ファイルを AccuRev に追加するには、ファイルを右クリックして [AccuRev に追加] を選択するか、外部ファイルにマウス カーソルを合わせたときに表示される + アイコンをクリックします。 その後、コメントを入力して 'Enter' を押すとワークスペースにファイルが追加されます。 AccuRev にファイルを追加すると、そのファイルはワークスペースの変更セクションに移動し、キープ状態になります。 |
| 自分の変更をキープ |
[自分の変更をキープ] コマンドは、変更を AccuRev に保存します。 [自分の変更をキープ] コマンドは、変更済みファイル (属性 M (青)) に対して利用可能です。 変更を親ストリームにプロモートまたはプッシュする前に、何度でもファイルをキープできます。 ファイルをキープすると、ワークスペースの変更セクションに移動し、プロモート可能になります。 ファイルの変更を AccuRev に保存 (キープ) するには、ファイルを右クリックして [自分の変更をキープ] を選択するか、変更済みファイルにマウス カーソルを合わせたときに表示される + アイコンをクリックします。 |
| プロモート |
[プロモート] コマンドを実行すると、ワークスペースの変更 が親ストリームに移動します。 変更パッケージを使用している場合は、プロモートを実行するための作業項目を選択する必要があります。 [プロモート] コマンドは、ワークスペースの変更 セクションのファイルに対して利用可能です。 組織において変更パッケージを使用している場合、作業項目 セクションで作業項目が選択されていないと、作業項目を選択するためのプロンプトが表示されます。 |
| リバート |
[リバート] コマンドは、ワークスペースのファイルに対して行った変更をキャンセルできます。 ワークスペースで少なくとも一度はキープされたワークスペースの変更にあるファイルの場合は、親バージョンにリバートを実行できます。 これにより、ワークスペースに対して行ったすべての変更が削除され、Backed ストリームのバージョンのファイルに戻ります。
ローカルの変更にあるファイルの場合は親バージョンにリバートまたは最新のバージョンにリバートを実行できます。 最新のバージョンにリバートは、キープしていない変更が破棄され、ワークスペースに最近キープしたバージョンに戻ります。 ワークスペースのファイルへの変更をキープしていない場合は、このバージョンは親バージョンになります。 |
| マージ |
ファイルに対して行った変更が、親ストリームのファイルの現在のバージョンと競合する場合、ファイルは オーバーラップする変更 セクションに表示されます。
競合を解決するには、ファイルを右クリックして [マージ] を選択します。 これにより、AccuRev マージ ウィンドウが表示されます。 競合を解決して結果を保存し、マージ作業を完了します。 確認プロンプトが表示されたら、[マージの承認] を選択して変更をキープするか、マージを [キャンセル] してください。 マージ ウィンドウの使用方法の詳細については、AccuRev ヘルプを参照してください。 |
| Diff |
[Diff] コマンドは、Visual Studio Code 差分エディターを使ってファイルの 2 つのバージョンを比較します。 差分エディターの使用方法についての詳細は、Visual Studio Code ヘルプを参照してください。
[Diff] > [Backed バージョン] は、ワークスペース ファイルのバージョンと親ストリームのバージョンを比較します。
[Diff] > [最新のバージョン] は、ワークスペース ファイルのバージョンと最近キープしたバージョンを比較します。 変更をキープしていない場合は、最近キープしたバージョンは、ファイルの親バージョンになります。 |
| AccuRev から削除 (デファンクト) |
削除したいファイルは、いつでもファイル システムから削除できます。 削除したファイルは、SCM ビューレットの 存在しないワークスペース ファイル の下に表示され、[AccuRev から削除 (デファンクト)] コマンドが実行できるようになります。 このコマンドを実行すると、AccuRev から削除されるファイルとしてマークされ、ワークスペースの変更 に移動してステータス D が表示されます。 デファンクト ファイルをプロモートすると、そのファイルは AccuRev 親ストリームから削除されます。 |
| 存在しない要素の復元 (ポピュレート) |
ファイルを誤って削除してしまった場合や、ファイルを元に戻したい場合は、SCM ビューレットで [存在しない要素の復元 (ポピュレート)] を選択して、AccuRev からファイルを再読み込みできます。 |
| ファイルを開く |
ファイルをエディターで開きます。 |
ファイル ステータス
ワークスペースのファイルは次のステータスを持ち、ソース管理セクションでは、ファイル名の右側に次の記号でマークされます。
| 記号 |
属性 |
説明 |
| K |
キープ済み (kept) |
AccuRev に保存されソース管理下にあるが、ワークスペース内でのみ、そのバージョンが利用可能なファイル |
| M (青) |
変更済み (modified) |
ワークスペースでローカルに保存されているが、AccuRev に保存されていないファイル |
| E |
外部 (external) |
AccuRev に追加されていないワークスペースのファイル |
| D |
デファンクト (defunct) |
AccuRev からの削除対象としてマークされたファイル。 ファイルが親ストリームにプロモートされると削除されます |
| O |
オーバーラップ (overlap) |
ワークスペースで変更した後で、親ストリームでも変更されたため、変更をプロモートする前にマージする必要があるファイル |
| M (赤) |
存在しない (missing) |
ワークスペースから削除されたが、親ストリームにまだ存在するファイル |
ログイン プロンプト
- AccuRev にログインしていない場合や、セッションの有効期限が切れた場合、ログイン プロンプトが表示されます。 ログインするサーバーを選択して 'Enter' を押します。 ユーザー名とパスワードをそれぞれのプロンプトに対して入力します。 ログインに失敗すると、ログイン プロンプトが再度表示されます。
メニューから [表示] > [コマンド パレット] を選択するか、Ctl-Shift-P を押下して次のコマンドを入力すると、いつでも AccuRev ログイン プロンプトを表示できます： AccuRev: AccuRev にログイン
Git サーバー リポジトリ
- AccuRev VSCode 拡張機能を使って、VSCode 上から Git サーバー リポジトリを扱うことができます。
- 変更パッケージのトリガーが設定されている場合、AccuWork 課題が 作業項目 セクションに表示されます。'プッシュ' コマンドを実行するときには、作業対象の課題を選択する必要があります。
既知の問題
- 課題または変更パッケージを選択するために、課題番号の行を選択する必要がある。 CPK 課題の表示をカスタマイズした場合に表示される補足フィールドの行では選択したことにはなりません (詳細については CPK 課題を参照)。
- ファイルやフォルダーの名前を変更する機能 (AccuRev rename)。
変更ログ
各バージョンにおける変更内容の詳細については、[変更ログ] を参照してください。
