GitHub Actions allows you to perform numerous tasks automatically, including using the cURL command to insert a new tag when a release is made or when a pull request is closed for example.
This tutorial demonstrates how to build an automation that will create a new tag in Coralogix upon publishing a new release of your code.
This document includes cluster-dependent URLs.
Refer to the following table to select the correct Coralogix Version Tags API endpoint for the domain associated with your Coralogix account.
Domain | Region | Endpoint |
---|---|---|
coralogix.us | US1 | https://webapi.coralogix.us/api/v1/external/tags/ |
coralogix.com | EU1 | https://webapi.coralogix.com/api/v1/external/tags/ |
eu2.coralogix.com | EU2 | https://webapi.eu2.coralogix.com/api/v1/external/tags/ |
app.coralogix.in | AP1 (IN) | https://webapi.app.coralogix.in/api/v1/external/tags/ |
coralogixsg.com | AP2 (SG) | https://webapi.coralogixsg.com/api/v1/external/tags/ |
STEP 1. Create your Action as a .yml file inside our repository in the workflows directory .github/workflows/my-tag-automation.yml.
Note:
STEP 2. Add the content of your action.
name: "Create a tag" on: release: types: [published]
name: "Create a tag" on: release: types: [published] jobs: run-updater: runs-on: ubuntu-latest steps: - name: create a tag run: | curl --location --request POST '<Cluster-endpoint>' \ --header 'Authorization: Bearer <Tags-api-key>' \ --header 'Content-Type: application/json' \ --data-raw '{ "name": "'"${GITHUB_REF##*/}"'", "application": ["<My-app>"], "subsystem": ["<My-subsystem>"] }'
${GITHUB_REF##*/} = a github action variable holding the reference of the action , in this context its the tag of the release.
<My-app> – Your Application name. You can input more than one name, use the comma delimiter ‘,’ between the names.
<My-subsystem> – Your Subsystem name. You can input more than one name, use the comma delimiter ‘,’ between the names.
<Cluster-endpoint> – The endpoint depended on your Coralogix domain
<Tags-api-key> – Alerts, Rules, and Tags API Key should be taken from Data Flow –> API Keys –> “Alerts, Rules and Tags API Key”
STEP 3. After publishing a new release, the Action will run, and a new tag in Coralogix will be created.
Need help?
Our world-class customer success team is available 24/7 to walk you through your setup and answer any questions that may come up.
Feel free to reach out to us via our in-app chat or by sending us an email at [email protected].