This action calls the Akamai Api's to submit mPulse annotations to the Akamai platform.
All sensitive variables should be set as encrypted secrets in the action's configuration.
You need to declare a AKAMAI_mPulseApiToken secret in your repository.
Follow this guide to retrieve your apiToken.
Required API Token: used to authenticate against the Akamai platform
Required Title: Currently set to use the following format: 'Repository name - Build build number'
Required current time in UTC milliseconds
Required Text: Currently set to use git commit message
Required List of domain id's: use a comma to seperate. i.e 123,123. Leave blank if not specifying
Required annotationID: Leave blank if the begining of the pipeline, or pull in via the saved artifact
Place in a .yml file such as this one in your .github/workflows folder. Refer to the documentation on workflow YAML syntax here.
steps:
- name: Annotation - start of deployment
uses: jdmevo123/[email protected]
with:
Auth-Token: ${{ secrets.AKAMAI_MPULSEAPITOKEN }}
title: ${{ github.event.repository.name }} - Build:${{ github.run_number }}
text: ${{ github.event.head_commit.message }}If you wish to submit domain id's, use the following YAML:
steps:
- name: Annotation - start of deployment
uses: jdmevo123/[email protected]
with:
Auth-Token: ${{ secrets.AKAMAI_MPULSEAPITOKEN }}
title: ${{ github.event.repository.name }} - Build:${{ github.run_number }}
text: ${{ github.event.head_commit.message }}
domainIds: "123,124" #Optional #Domain ID's split by comma. i.e. "123,124"This project is distributed under the MIT license.