zeit.deploynotify 1.4.0

No project description provided

This package collects the mechanics for sending notifications “version x of project y was just deployed to environment z”, for example to set markers in observability systems like Grafana, post a message to a slack channel, transition issues in jira to the corresponding status, etc.

Usage

The package provides a “multi subcommand” CLI interface:

python -m zeit.deploynotify
    --environment=staging --project=example --version=1.2.3 \
    slack --channel=example --emoji=palm_tree

Typically this will be integrated as a Keptn Deployment Task, like this:

apiVersion: external-secrets.io/v1beta1
kind: ExternalSecret
metadata:
  name: deployment-notify
spec:
  refreshInterval: 1h
  secretStoreRef:
    name: baseproject-vault
    kind: SecretStore
  data:
  - secretKey: SLACK_HOOK_TOKEN
    remoteRef:
      key: zon/v1/slack/hackbot
      property: HOOK_TOKEN
---
apiVersion: lifecycle.keptn.sh/v1alpha3
kind: KeptnTaskDefinition
metadata:
  name: notify
spec:
  container:
    name: task
    image: europe-west3-docker.pkg.dev/zeitonline-engineering/docker-zon/deploynotify:1.0.0
    envFrom:
      - secretRef:
          name: deployment-notify
    args:
      - "--environment=staging"
      - "slack"
      - "--channel=example"
      - "--emoji=palm_tree"

Changelog

1.4.0 (2024-07-30)

Changes

• ZO-5636: Support honeycomb environments marker (ZO-5636)

1.3.0 (2024-02-22)

Changes

• Update to keptn-0.10 context API (keptn)

1.2.3 (2024-01-17)

Changes

• Fix jira status change (jira)

1.2.2 (2024-01-16)

Changes

• Don’t set jira status if status is already ‘more done’ (jira)

1.2.1 (2024-01-11)

Changes

• Detect empty postdeploy properly (postdeploy)

1.1.1 (2024-01-08)

Changes

• Quote changelog text correctly for slack (changelog)

1.1.0 (2024-01-08)

Changes

• ZO-4171: Implement posting the changelog diff to slack (changelog)

1.0.4 (2024-01-08)

Changes

• postdeploy: Retrieve changelog of the deployed version (postdeploy)

1.0.3 (2023-12-18)

Changes

• Fix jira changelog parsing (jira)

1.0.2 (2023-12-18)

Changes

• Fix bugsnag cli parsing (bugsnag)

1.0.1 (2023-12-18)

Changes

• Allow calling multiple tasks in a single invocation (chain)

1.0.0 (2023-12-13)

Changes

• Initial release (initial)