aio-cloudmanager-create-execution-action

GitHub action that starts a Cloud Manager pipeline execution

Authentication

To use this action, you must create aan integration must be created in the Adobe I/O Developer Console which has the Cloud Manager service. See the Cloud Manager API Documentation for more information.

Configuration

This action can be configured two different ways -- either in combination with aio-apps-action or standalone. The former would be appropriate if your workflow involved other Adobe I/O integrations since the same access token could be used for multiple actions.

Standalone usage

Using JWT integration

NOTE: The JWT mode of authentication is deprecated and will be completely removed by Jan,2025. So if you are using JWT integration, it is recommended to migrate to OAuth. Check migration guide for more details.

• CLIENTID - Client ID for the project in the I/O Developer Console
• CLIENTSECRET - Client Secret for the project in the I/O Developer Console
• TECHNICALACCOUNTID - Technical Account Email for the project in the I/O Developer Console
• IMSORGID - IMS Organization ID for the project in the I/O Developer Console
• KEY - Private key for the project in the I/O Developer Console
• PROGRAMID - Cloud Manager Program ID
• PIPELINEID - Cloud Manager Pipeline ID

- name: Create Execution
  uses: adobe/aio-cloudmanager-create-execution-action@v1.2.0
  with:
    CLIENTID: ${{ secrets.CM_CLIENT_ID }}
    CLIENTSECRET: ${{ secrets.CM_CLIENT_SECRET }}
    TECHNICALACCOUNTID: ${{ secrets.CM_TA_EMAIL }}
    IMSORGID: ${{ secrets.CM_ORG_ID }}
    KEY: ${{ secrets.CM_PRIVATE_KEY }}
    PIPELINEID: ${{ secrets.CM_PIPELINE_ID }}
    PROGRAMID: ${{ secrets.CM_PROGRAM_ID }}

Using OAUTH integration

• CLIENTID - Client ID for the project in the I/O Developer Console
• CLIENTSECRET - Client Secret for the project in the I/O Developer Console
• TECHNICALACCOUNTID - Technical Account ID for the project in the I/O Developer Console
• TECHNICALACCOUNTEMAIL - Technical Account Email for the project in the I/O Developer Console (previously called TECHNICALACCOUNTID for JWT configuration)
• IMSORGID - IMS Organization ID for the project in the I/O Developer Console
• PROGRAMID - Cloud Manager Program ID
• PIPELINEID - Cloud Manager Pipeline ID
• OAUTHENABLED - set to 'true'(string) to identify OAuth integration

- name: Create Execution
  uses: adobe/aio-cloudmanager-create-execution-action@v1.2.0
  with:
    CLIENTID: ${{ secrets.CM_CLIENT_ID }}
    CLIENTSECRET: ${{ secrets.CM_CLIENT_SECRET }}
    TECHNICALACCOUNTID: ${{ secrets.CM_TA_ID }}
    TECHNICALACCOUNTEMAIL: ${{ secrets.CM_TA_EMAIL }}
    IMSORGID: ${{ secrets.CM_ORG_ID }}
    PIPELINEID: ${{ secrets.CM_PIPELINE_ID }}
    PROGRAMID: ${{ secrets.CM_PROGRAM_ID }}
    OAUTHENABLED: 'true'

Usage with aio-apps-action

1. Add a step which uses adobe/aio-apps-action providing these required inputs:

• command - set to auth
• CLIENTID - Client ID for the project in the I/O Developer Console
• CLIENTSECRET - Client Secret for the project in the I/O Developer Console
• TECHNICALACCOUNTID - Technical Account ID for the project in the I/O Developer Console
• TECHNICALACCOUNTEMAIL - Technical Account Email for the project in the I/O Developer Console (Only for OAuth integration; previously called TECHNICALACCOUNTID for JWT configuration)
• IMSORGID - IMS Organization ID for the project in the I/O Developer Console
• SCOPES - set to ent_cloudmgr_sdk at minimum for JWT and openid, AdobeID, read_organizations, additional_info.projectedProductContext, read_pc.dma_aem_ams for OAuth
• KEY - Private key for the project in the I/O Developer Console (Only for JWT integration)
• OAUTHENABLED - set to true for OAuth-type integrations (required for OAuth integration; optional for JWT integration)

For example:

- name: Auth
  uses: adobe/aio-apps-action@2.0.1
  with:
    command: auth
    CLIENTID: ${{ secrets.CM_CLIENT_ID }}
    CLIENTSECRET: ${{ secrets.CM_CLIENT_SECRET }}
    TECHNICALACCOUNTID: ${{ secrets.CM_TA_EMAIL }}
    IMSORGID: ${{ secrets.CM_ORG_ID }}
    SCOPES: 'ent_cloudmgr_sdk'
    KEY: ${{ secrets.CM_PRIVATE_KEY }}

2. Add a step which uses this action providing these required inputs:

• PROGRAMID - Cloud Manager Program ID
• PIPELINEID - Cloud Manager Pipeline ID
• IMSORGID - IMS Organization ID for the project in the I/O Developer Console

For example:

- name: Create Execution
  uses: adobe/aio-cloudmanager-create-execution-action@v1.2.0
  with:
    PIPELINEID: ${{ secrets.CM_PIPELINE_ID }}
    PROGRAMID: ${{ secrets.CM_PROGRAM_ID }}
    IMSORGID: ${{ secrets.CM_ORG_ID }}

Output

This action creates two outputs which can be referenced in later steps:

• executionId - the ID of the created execution
• executionHref - the URL of the created execution

Contributing

Contributions are welcome! Read the Contributing Guide for more information.

Licensing

This project is licensed under the Apache V2 License. See LICENSE for more information.