This action installs the IBM Cloud CLI and authenticates with IBM Cloud so you can run commands against it.

name: My workflow
on: [push, pull_request]
jobs:
  test:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - name: Set up ibmcloud CLI
      uses: IBM/actions-ibmcloud-cli@v1
      with:
        api_key: ${{ secrets.IBMCLOUD_API_KEY }}
        region: us-south
        group: default
        plugins: container-service, secrets-manager
    - run: ibmcloud --version

• plugins: (optional) A comma, space, or newline separated list of CLI plugins to be installed.

  The plugins can listed as PLUGIN_NAME (e.g. container-service) or PLUGIN_NAME@VERSION (e.g. [email protected])

  For more information about plugins see https://cloud.ibm.com/docs/cli?topic=cli-plug-ins

  Examples:

  plugins: [email protected], secrets-manager

  plugins: [email protected] secrets-manager

  plugins: |
    [email protected]
    secrets-manager

• api: (optional - default: https://cloud.ibm.com) API endpoint to IBM Cloud

• api_key: (optional) API Key to login to IBM Cloud

  If not provided, no attempt will be made to login in and you will need to login with the IBM Cloud CLI directly in a subsequent step.

• region: (optional - default: us-south) Region to access on IBM Cloud

• group: (optional - default: default) Resource group to access on IBM Cloud

• version: The version of the IBM Cloud CLI that was installed

  This can be accessed in a subsequent step by accessing the outputs as follows:

  steps:
    - uses: actions/checkout@v4
    - name: Set up ibmcloud CLI
      id: ibmcloud
      uses: IBM/actions-ibmcloud-cli@v1
    - run: ibmcloud --version
           # => ibmcloud 2.31.0 (6b1eddc-2024-12-05T17:30:20+00:00)
    - run: echo The version installed is ${{ steps.ibmcloud.outputs.version }}
           # => The version installed is 2.31.0

The action works on these GitHub-hosted runners images. Runner images not listed below are not supported yet.

See CONTRIBUTING.md.

The gem is available as open source under the terms of the Apache License 2.0.