run-oci-cli-command

This GitHub Action installs the OCI CLI and then runs the specified command. This action will automatically cache the OCI CLI install to speed up any subsequent steps that use this action.

Required environment variables

The following OCI CLI environment variables must be defined for at least the run-oci-cli-command task:

• OCI_CLI_USER
• OCI_CLI_TENANCY
• OCI_CLI_FINGERPRINT
• OCI_CLI_KEY_CONTENT
• OCI_CLI_REGION

We recommend using GitHub Secrets to store these values. If you have more than one run-oci-cli-command task, consider defining your environment variables at the job or workflow level.

Inputs

• command (required): the command and arguments to provide to the oci tool.
• query: (optional) a JMESPath query to run on the response JSON before output.

Output masking

By default, the output(s) from the command are masked from the GitHub Actions log and GitHub console, to prevent leaking any credential or confidential information. The following option will disable that masking and is intended for debugging purposes only:

• silent: (Optional; default: true) If set to false the action will not mask or suppress the command or outputs from the logs or console.

Note: the output does not need to be visible in the log to be used as an input by another task.

Outputs

• output: will contain the results of the command in JSON format.
• raw_output: if the output of a given query is a single string value, raw_output will return the string without surrounding quotes.

Note: filtering the output or raw_output by piping it through another tool like jq may result in the filtered output being visible in the job logs. We recommend using the query parameter instead.

Sample workflow

The following example lists all compute instances found in the testing compartment of the OCI_CLI_TENANCY in the OCI_CLI_REGION region.

To change the name of the compartment, modifying the query parameter of the find-compartment-id step.

To change which fields are returned, modify the query parameter of the find-instances step.

jobs:
  my-instances:
    runs-on: ubuntu-latest
    name: List the display name and shape of the instances in my compartment
    env:
      OCI_CLI_USER: ${{ secrets.OCI_CLI_USER }}
      OCI_CLI_TENANCY: ${{ secrets.OCI_CLI_TENANCY }}
      OCI_CLI_FINGERPRINT: ${{ secrets.OCI_CLI_FINGERPRINT }}
      OCI_CLI_KEY_CONTENT: ${{ secrets.OCI_CLI_KEY_CONTENT }}
      OCI_CLI_REGION: ${{ secrets.OCI_CLI_REGION }}
    steps:
      - name: Retrieve the OCID of a named compartment in tenancy
        uses: oracle-actions/run-oci-cli-command@v1.2.0
        id: find-compartment-id
        with:
          command: 'iam compartment list --compartment-id-in-subtree=true'
          query: "data[?name=='testing'].id"

      - name: Retrieve the display name and shape of the instances in my compartment
        uses: oracle-actions/run-oci-cli-command@v1.2.0
        id: find-instances
        with:
          command: 'compute instance list --compartment-id ${{ steps.find-compartment-id.outputs.raw_output }}'
          query: 'data[*].{name: \"display-name\", shape: shape}'

      - name: List the display name and shape of the instances in my compartment
        run: |
          echo ${{ steps.find-instances.outputs.output }} | jq .

Consult the JMESPath documentation for details on how to create more complex queries and result formatting and action.yml for more detail on how to configure this action..

Contributing

We welcome contributions from the community. Before submitting a pull request, please review our contribution guide.

Security

Please consult the security guide for our responsible security vulnerability disclosure process.

License

Copyright (c) 2021, 2024, Oracle and/or its affiliates.

Released under the Universal Permissive License v1.0 as shown at https://oss.oracle.com/licenses/upl/.