The Code Pipeline Build action allows your GitHub Actions workflow to trigger a build in your instance of BMC AMI DevX Workbench Code Pipeline on the mainframe. This action can be used in scenarios where your mainframe source is stored in git, or when you want your GitHub Actions workflow to operate on source that is already stored in Code Pipeline.

The following example will automatically retrieve the build parameters from a previous sync step in the job

on: [push]

jobs:
  run-code-pipeline-build:
    runs-on: [self-hosted, ubuntu-ispw]
    name: A job to sync git source into Code Pipeline, then build it on the mainframe
    steps:
      - name: Sync step
        uses: bmc-compuware/ispw-sync@v1
        id: sync
        with:
          host: 'host.example.com'
          port: 37733
          uid: ${{ secrets.TSOUSER }}
          pass: ${{ secrets.TSOPASS }}
          runtimeConfiguration: 'ISPW'
          stream: 'PLAY'
          application: 'PLAY'
          checkoutLevel: 'DEV2'
          gitUid: 'admin'
          gitToken: ${{ secrets.GITHUB_TOKEN }}
          showEnv: true
      - name: Build
        uses: bmc-compuware/ispw-build@v1
        id: build
        with:
          ces_url: 'https://CES:48226/'
          ces_token: ${{ secrets.CES_TOKEN }}
          srid: 'host-37733'
          runtime_configuration: 'ISPW'
          build_automatically: ${{ steps.sync.outputs.automaticBuildJson }}
      - name: Get the number of generate failures
        run: echo "The number of generate failures is ${{ steps.build.outputs.generate_failed_count }}"

The following example will generate two specific Code Pipeline tasks using ces_token as authentication method

on: [push]

jobs:
  run-code-pipeline-build:
    runs-on: [self-hosted, ubuntu-ispw]
    name: A job to build source in Code Pipeline
    steps:
      - name: Build
        uses: bmc-compuware/ispw-build@v1
        id: build
        with:
          ces_url: "https://CES:48226/"
          ces_token: ${{ secrets.CES_TOKEN }}
          srid: host-37733
          runtime_configuration: ISPW
          task_id: "7E3A5B274D24,7E3A5B274EFA"
      - name: Get the set ID for the build
        run: echo "The Code Pipeline set used for the build is ${{ steps.build.outputs.set_id }}"

The following example will generate two specific Code Pipeline tasks using certificate as authentication method

on: [push]

jobs:
  run-code-pipeline-build:
    runs-on: [self-hosted, ubuntu-ispw]
    name: A job to build source in Code Pipeline
    steps:
      - name: Build
        uses: bmc-compuware/ispw-build@v1
        id: build
        with:
          ces_url: "https://CES:48226/"
          certificate: ${{ secrets.certificate }}
          srid: host-37733
          runtime_configuration: ISPW
          task_id: "7E3A5B274D24,7E3A5B274EFA"
      - name: Get the set ID for the build
        run: echo "The Code Pipeline set used for the build is ${{ steps.build.outputs.set_id }}"

| ces_token | Optional | The token to use when authenticating the request to CES | | certificate | Optional | The certificate to use when authenticating the request to CES |

Users must pass one of the authentication method in workflow i.e ces_token or certificate.

In order to use this action, you must have an instance of the CES product installed on one of your runners. Once that is complete, you will need to open CES in your web browser and create a token to be used during CES requests. To set up a new host connection, go to the hamburger menu in the upper left corner and select Host Connections.

On the Host Connection Settings page, click "Add." Set up the host connection to be used for Code Pipeline and click OK when finished.

Then, go back to the menu and select Security. On the Security page, click Add and the Personal Access Token dialog will come up.

On the Personal Access Token dialog, select the host that you want to create a token for, and enter in the mainframe username and password.

Once done, there will be a new token in the table on the Security page

From the Security page in CES, copy the token. In GitHub go to Settings > Secrets and click the button for New Repository Secret.

On the New Secret page, paste the token that was copied earlier and click the Add secret button. Make a note of the name you give the secret so that you can easily use it in your workflow script.

Once you get the certificate, copy the 64bit text without and line breaks. In GitHub go to Settings > Secrets and click the button for New Repository Secret.

On the New Secret page, paste the certificate that was copied earlier and click the Add secret button. Make a note of the name you give the secret so that you can easily use it in your workflow script.

Use the examples above to fill in a workflow script using the Code Pipeline Build action. Note that if you want taskIds to be automatically picked up from the Code Pipeline synchronization with Git, you will need a synchronization step in you job, which will run before the build.

To enable debug logging in your GitHub actions workflow, see the guide here.

For information about contributing to the Code Pipeline Build action, see Developing on the Code Pipeline Build GitHub action

• License