{"id":28961746,"url":"https://github.com/getappmap/action-utils","last_synced_at":"2025-06-24T02:04:52.310Z","repository":{"id":194875412,"uuid":"688512051","full_name":"getappmap/action-utils","owner":"getappmap","description":"Utility commands and functions for AppMap GitHub Actions","archived":false,"fork":false,"pushed_at":"2023-10-31T20:52:10.000Z","size":133,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-04-24T09:55:18.281Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/getappmap.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-09-07T13:54:01.000Z","updated_at":"2024-04-24T09:55:18.282Z","dependencies_parsed_at":null,"dependency_job_id":"adf80921-7db1-448b-a144-51bfb003d180","html_url":"https://github.com/getappmap/action-utils","commit_stats":null,"previous_names":["getappmap/action-utils"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/getappmap/action-utils","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getappmap%2Faction-utils","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getappmap%2Faction-utils/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getappmap%2Faction-utils/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getappmap%2Faction-utils/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/getappmap","download_url":"https://codeload.github.com/getappmap/action-utils/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getappmap%2Faction-utils/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261589912,"owners_count":23181437,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-24T02:04:51.583Z","updated_at":"2025-06-24T02:04:52.243Z","avatar_url":"https://github.com/getappmap.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# getappmap/install-appmap\n\nTo see a step-by-step example of how to install this action into your software project, [review the official AppMap Documentation](http://appmap.io/docs/analysis/in-github-actions).\n\nThis is a GitHub action to install and configure AppMap. It will do the following things:\n\n- Install the AppMap tools (CLI)\n- (Optional) Install the AppMap library for the language and build system (e.g. Java + Maven, Ruby + Bundler,\n  JS + yarn, etc).\n- (Optional) Configure the AppMap library by creating a default _appmap.yml_.\n\nAppMap configuration can also be explicitly provided via `appmap-config` parameter.\n\nOn completion, a patch file of the changes applied to the repo is attached as a GitHub artifact. You\ncan also add the following step to your workflow to commit the changes automatically:\n\n```\n      - name: Commit changes\n        uses: EndBug/add-and-commit@v9\n```\n\n## Prerequisites\n\nBefore running this action, ensure that the programming language and package manager used by your\nproject are installed and available.\n\n## Usage\n\nSet the `project-type` to ensure the AppMap library is installed via the correct package manager.\n\n```\n- name: Install AppMap tools\n  uses: getappmap/install-action@v1\n  with:\n    project-type: bundler # Choose the type of your project here:\n                        # bundler, maven, gradle, pip, pipenv, poetry,\n                        # yarn, npm, etc.\n```\n\n\nIf your project alrady has the AppMap software libraries and configuration files installed, use `install-appmap-library: false` to skip the install of the libraries and only install the CLI tools which are required for later steps:\n\n\n```\n- name: Install AppMap tools\n  uses: getappmap/install-action@v1\n  with:\n    install-appmap-library: false\n```\n\n## Development\n\n```\n# Remove build artifacts\n$ yarn clean\n\n# Build the project\n$ yarn build\n\n# Run tests\n$ yarn test\n\n# Package the project into a distributable GitHub action\n$ yarn package\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgetappmap%2Faction-utils","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgetappmap%2Faction-utils","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgetappmap%2Faction-utils/lists"}