AppMaps are great for sharing your knowledge about how old and new code works and behaves. This guide describes suggested workflows for sharing AppMaps with your peers.
json files that can be viewed by anyone with an AppMap interactive viewer. The viewer is available in:
Here are a few suggested strategies for sharing your AppMap files with your peers:
AppMap Cloud is a fast and convenient method for sharing AppMaps:
Upload AppMaps to AppMap Cloud without leaving your code editor:
When someone shares an AppMap published in AppMap Cloud, you’ll receive a link and have two options for using the AppMap:
AppMaps can be recorded from AppMap-instrumented web applications and uploaded to AppMap Cloud with the AppMap browser extension directly from your web browser.
Uploading and sharing of AppMaps can be automated and integrated into your development workflows. AppMap recording and uploading scripts can be added to your CI/CD pipeline so you have AppMaps available for every published release or for each major code update. To learn more, visit CLI for AppMap Cloud.
A simple way of adding an AppMap to an issue is to insert the AppMap JSON file as an attachment. You can reveal the location of the AppMap file using the AppMap extension for your code editor.
Warning: Files with a JSON extension cannot be directly attached to GitHub issues. We recommend that you zip .appmap.json files prior to attaching them.
In code editors:
AppMaps attached to tickets can be directly saved as
.appmap.json files into project folders and opened in code editors. You’ll need AppMap for JetBrains or VSCode installed in order to open downloaded AppMaps.
.appmap.jsonfile. Files with a different extension or with just a
.jsonextension will not be recognized or opened in the interactive viewer.
If your organization uses file sharing services or shared network drives, these are excellent methods for sharing AppMap
appmap.json files with your team:
Note: You can add the shared folders to your VSCode Workspace for quick copying of AppMaps between folders right in your code editor:
Filemenu, pick the
Add Folder to Workspace...menu and select a shared folder.
To view AppMaps (
.appmap.json files), you’ll need a supported code editor (VSCode or a JetBrains IDE) and the AppMap extension.
Simply open any
appmap.json file in your filesystem with your code editor and the AppMap will open with the AppMap interactive viewer.