On this page
article
ipm-init
Initialize a new IPM workspace in your GitHub Actions workflow
ipm-init
Initializes a new IPM workspace in the specified directory by running ipm init. Use this action when your workflow needs to set up a fresh workspace before adding or syncing packages.
This action does not require authentication.
Usage
- uses: ipmhubio/ipm-actions/.github/actions/ipm-init@v1
with:
working-directory: '.' # Optional: directory to initialize (default: '.')
Inputs
| Input | Required | Default | Description |
|---|---|---|---|
working-directory |
No | . |
Directory where ipm init will run. |
hide-banner |
No | false |
Set to true to suppress the IPM CLI banner in the log output. |
ipm-version |
No | latest | Specific IPM version to use, without the v prefix. Omit for latest. |
Examples
Initialize a workspace at the repo root
- uses: actions/checkout@v4
- name: Init IPM workspace
uses: ipmhubio/ipm-actions/.github/actions/ipm-init@v1
Initialize in a subdirectory
- name: Init workspace
uses: ipmhubio/ipm-actions/.github/actions/ipm-init@v1
with:
working-directory: ./infrastructure
Use a pinned IPM version with a clean log
- name: Init workspace
uses: ipmhubio/ipm-actions/.github/actions/ipm-init@v1
with:
working-directory: ./infrastructure
ipm-version: '0.12.0'
hide-banner: 'true'
`ipm-init` only needs to run once per workspace. If your workspace already has an `ipmhub.json`, you can skip this action and go straight to `ipm-sync`.