Custom GitHub action which facilitates communication between GitHub and ALM Octane/ValueEdge regarding CI/CD.
on:
workflow_run:
workflows: [<workflow_name1>, <workflow_name2>, ...]
types: [requested, in_progress, completed]
pull_request:
types: [opened, edited, closed, reopened]env:
NODE_TLS_REJECT_UNAUTHORIZED: 0Settings -> Actions -> General and set your GITHUB_TOKEN permissions to Read and write. This is necessary to access the actions scope. (more details about GITHUB_TOKEN permissions here)jobs:
octane_integration_job:
runs-on: <runner_tags>
name: OctaneIntegration#${{github.event.action}}#${{github.event.workflow_run.id}}
steps:
- name: GitHub Actions ALM Octane Integration
uses: MicroFocus/alm-octane-github-actions-integration
id: gitHubActionsIntegration
with:
octaneUrl: <alm_octane_URL>
octaneSharedSpace: <alm_octane_shared_space>
octaneWorkspace: <alm_octane_workspace>
octaneClientId: ${{secrets.ALM_OCTANE_CLIENT_ID}}
octaneClientSecret: ${{secrets.ALM_OCTANE_CLIENT_SECRET}}
githubToken: ${{secrets.GITHUB_TOKEN}}
serverBaseUrl: <github_repository_URL>
pipelineNamePattern: '${workflow_name}'
unitTestResultsGlobPattern: <pattern_for_test_result_path>Example of complete integration workflow configuration file:
name: OctaneIntegration
# Events the integration should be triggered on
on:
pull_request:
types: [opened, edited, closed, reopened]
workflow_run:
# List of workflows to integrate with ALM Octane
workflows: [CI]
types: [requested, in_progress, completed]
# Node configuration for allowing HTTPS requests
env:
NODE_TLS_REJECT_UNAUTHORIZED: 0
jobs:
octane_integration_job:
# List of runner tags
runs-on: [self-hosted]
name: OctaneIntegration#${{github.event.action}}#${{github.event.workflow_run.id}}
steps:
- name: GitHub Actions ALM Octane Integration
# Reference to our public GitHub action
uses: MicroFocus/alm-octane-github-actions-integration
id: gitHubActionsIntegration
# Config parameters for the integration
with:
# ALM Octane connection data
octaneUrl: 'http://myOctaneUrl.com'
octaneSharedSpace: 1001
octaneWorkspace: 1002
octaneClientId: ${{secrets.ALM_OCTANE_CLIENT_ID}}
octaneClientSecret: ${{secrets.ALM_OCTANE_CLIENT_SECRET}}
# Automatically provided GitHub token
githubToken: ${{secrets.GITHUB_TOKEN}}
# The url that the CI Server in ALM Octane will point to
serverBaseUrl: https://github.com/MyUser/MyCustomRepository
# Pattern for building the name of the pipeline (see README for full list of placeholders)
pipelineNamePattern: '${workflow_name}'
# Pattern for identifying JUnit style report files for test result injection in ALM Octane
unitTestResultsGlobPattern: "**/*.xml"The pipelineNamePattern parameter from the integration workflow configuration represents the format of the pipeline name that will be displayed in the OpenText Software Delivery Platform.
This parameters can contain any combination of the following placeholders:
${repository_name} - the name of the repository${repository_owner} - the name of the account or organization owning the repository.${workflow_name} - the name of the workflow.${workflow_file_name} - the name of the workflow's configuration file.Example: NEW - ${repository_name} - ${workflow_name}
logLevel and is an optional parameter.