getappmap/Install and configure AppMap

Installs AppMap tools and the AppMap language library, and configures AppMap options for the project.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
Runtime
Deprecated runtime
namedescriptionrequireddefault
directoryCommand working directory.
appmap-configappmap.yml configuration contents.
project-typeType of project to be configured. Valid values include bundler, yarn, npm, gradle, maven, pip, pipenv, and poetry. Consult https://appmap.io/docs/add-appmap-to-a-project.html for more information.
build-fileBuild file to be configured, in case of ambiguity. This is an advanced option.
installer-nameInstaller name to be used, in case of ambiguity. This is an advanced option.
tools-urlURL to the AppMap tools. By default, the latest version will be downloaded and installed.
github-tokenThe GitHub token to use with the GitHub API to enumerate AppMap Tools releases. Most commonly, you'll use `secrets.GITHUB_TOKEN`, which is automatically provided by GitHub. ${{ github.token }}
ignore-dot-appmapAdd the .appmap directory to .gitignore, if it's not already present. true
install-appmap-toolsInstall the AppMap command-line tools. true
install-appmap-libraryInstall the and configure the AppMap language library. true
build-patch-fileCreate a patch file of changes made by the installer. true
diff-path-specPath specification to use when creating the patch file. If the patch file includes files that you don't want to commit, you can use this option to exclude them. . ':(exclude,top)vendor' ':(exclude,top)node_modules'
expected-appmap-dirExpected value of the appmap_dir in appmap.yml. If this input is provided, the action will verify that the configured appmap_dir matches the expected value. If the value does not match, the action will fail.
verboseEnable verbose logging.false
namedescription
patchPatch file of changes made by the installer.
appmap-dirDirectory containing recorded AppMaps; this information can also be obtained from the appmap_dir entry in the appmap.yml configuration file.