taupiknr26/gitlab-telegram-alert

Docker image for gitlab ci/cd for deploy result alerting with telegram bot

Gitlab Telegram Alert

Docker image for send gitlab ci/cd build results to telegram chat with bot

Usage

Set global environment variables in .gitlab-ci.yml:

variables:
  # ... some variables
  PARSE_MODE: 'Markdown'       # Support HTML, default: Markdown
  CHAT_ID: $CHAT_ID            # Set CHAT_ID repository secret
  BOT_TOKEN: $BOT_TOKEN        # Set BOT_TOKEN repository secret
  DISABLE_NOTIFICATION: True   # Default = False

Job for notify success build:

notify_success:
  stage: <stage>
  image: suchimauz/gitlab-telegram-alert:v1.0.0
  variables:
    # For off pulling repository
    GIT_STRATEGY: none
    MESSAGE: |
      ✅ Success build \*$CI_PROJECT_NAME:$CI_COMMIT_BRANCH\*
      $CI_COMMIT_TITLE

      Commit by: \*$CI_COMMIT_AUTHOR\*
      $CI_PIPELINE_URL
  # It's hack :(
  script:
    - /entrypoint.sh
  rules:
    - if: '$CI_COMMIT_BRANCH == "master"'

Also for error build:

notify_error:
  stage: <stage>
  image: suchimauz/gitlab-telegram-alert:v1.0.0
  variables:
    # For off pulling repository
    GIT_STRATEGY: none
    MESSAGE: |
      ❌ Error build \*$CI_PROJECT_NAME:$CI_COMMIT_BRANCH\*
      $CI_COMMIT_TITLE

      Commit by: \*$CI_COMMIT_AUTHOR\*
      $CI_PIPELINE_URL
  script:
    - /entrypoint.sh
  rules:
    - if: '$CI_COMMIT_BRANCH == "master"'
      when: on_failure

Don't forget to add your to the stages section:

variables: 
  #...

stages:
  # some stages
  - <stage>
  
notify_success:
  stage: <stage>
  #...
notify_error:
  stage: <stage>
  #...

Also you can customize your message as you like using environments from gitlab ci/cd: https://docs.gitlab.com/ee/ci/variables/

Success build

✅ Success build repository:branch
Commit message

Commit by: username <[email protected]>
https://gitlab.com/uri_to_pipeline

Error build

❌ Error build repository:branch
Commit message

Commit by: username <[email protected]>
https://gitlab.com/uri_to_pipeline