We just raised $142 million in our Series D Round! Read About Our Plans for the Future

GitHub Version Tags GitHub Version Tags

Last Updated: Jun. 20, 2022

Using GitHub Actions we can perform numerous tasks automatically, one of them is to use the cURL command to insert a new tag when a release is made or when a pull request is closed for example.

For more information about the usage of the cURL command with Coralogix tags visit:

https://coralogix.com/docs/version-tags-with-curl/

Note: This document includes cluster-dependent URLs. Please refer to the following table to select the correct Coralogix Version Tags API endpoint for your Coralogix Portal domain’s extension (.com/.us/.in).

RegionEndpoint
.comhttps://webapi.coralogix.com/api/v1/external/tags/
.ushttps://webapi.coralogix.us/api/v1/external/tags/
.inhttps://webapi.app.coralogix.in/api/v1/external/tags/

This tutorial will explain how to build an automation that will create a new tag in Coralogix upon publishing a new release of your code.

First, we create our Action as a .yml file inside our repository in the workflows directory .github/workflows/my-tag-automation.yml

* Remember to place the .github folder inside the root folder of your repository.

Now, let’s add the content of our action. First, we add the name of the automation and the events that activate it:

name: "Create a tag"
 
on:
  release:
    types: [published]

Then add the ‘job’ of our automation — the action that it will execute:

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 the cluster

<Tags-api-key> – Alerts, Rules, and Tags API Key should be taken from

Data Flow –> API Keys –> “Alerts, Rules and Tags API Key”

And that’s it! After publishing a new release the action will run and a new tag in Coralogix will be created.

For more information about GitHub Actions visit:

https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions

On this page