slack-git-compare

🗄️ slack-git-compare

This is a slack command handler to compare git refs from whether GitHub or GitLab, within Slack

How it works

This repositories holds the code of a daemon which communicates with git providers and can handle Slack interactions.

Install

Go

~$ go install github.com/mvisonneau/slack-git-compare/cmd/slack-git-compare@latest

Snapcraft

~$ snap install slack-git-compare

Homebrew

~$ brew install mvisonneau/tap/slack-git-compare

Docker

~$ docker run -it --rm docker.io/mvisonneau/slack-git-compare
~$ docker run -it --rm ghcr.io/mvisonneau/slack-git-compare
~$ docker run -it --rm quay.io/mvisonneau/slack-git-compare

Scoop

~$ scoop bucket add https://github.com/mvisonneau/scoops
~$ scoop install slack-git-compare

Binaries, DEB and RPM packages

Have a look onto the latest release page to pick your flavor and version. Here is an helper to fetch the most recent one:

~$ export SGC_VERSION=$(curl -s "https://api.github.com/repos/mvisonneau/slack-git-compare/releases/latest" | grep '"tag_name":' | sed -E 's/.*"([^"]+)".*/\1/')

# Binary (eg: linux/amd64)
~$ wget https://github.com/mvisonneau/slack-git-compare/releases/download/${SGC_VERSION}/slack-git-compare_${SGC_VERSION}_linux_amd64.tar.gz
~$ tar zxvf slack-git-compare_${SGC_VERSION}_linux_amd64.tar.gz -C /usr/local/bin

# DEB package (eg: linux/386)
~$ wget https://github.com/mvisonneau/slack-git-compare/releases/download/${SGC_VERSION}/slack-git-compare_${SGC_VERSION}_linux_386.deb
~$ dpkg -i slack-git-compare_${SGC_VERSION}_linux_386.deb

# RPM package (eg: linux/arm64)
~$ wget https://github.com/mvisonneau/slack-git-compare/releases/download/${SGC_VERSION}/slack-git-compare_${SGC_VERSION}_linux_arm64.rpm
~$ rpm -ivh slack-git-compare_${SGC_VERSION}_linux_arm64.rpm

HELM

If you want to make it run on kubernetes, there is a helm chart available for this purpose.

You can check the chart's values.yml for complete configuration options.

# Add the helm repository to your local client
~$ helm repo add mvisonneau https://charts.visonneau.fr

# Configure a minimal configuration for the exporter
# only one of github/gitlab needs to be configured
~$ cat <<EOF > values.yml
config:
  providers:
    - type: github
      token: <your-github-token>
      owners: [ <your-github-orgs> ]
    - type: gitlab
      token: <your-gitlab-token>
      owners: [ <your-gitlab-groups> ]

  slack:
    token: '<your-slack-token>'
    signing-secret: '<your-slack-signing-secret>'
EOF

# Release the chart on your Kubernetes cluster
~$ helm upgrade -i slack-git-compare mvisonneau/slack-git-compare -f values.yml

Examples / Getting Started

Here is documentation about how to get started with the tool.

Limitations / Known issues

• For readability purposes, we currently only display up to 15 commits and 7 authors per diff
• As we cache refs, it is not possible to use a commit SHA as ref, solely:
  • branch
  • tag
  • environment (GitLab only)

Usage

~$ slack-git-compare --help
NAME:
   slack-git-compare - Compare git refs within Slack

USAGE:
   slack-git-compare [global options] command [command options] [arguments...]

COMMANDS:
   help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --config file, -c file                 config file (dhall, json or yaml format) (default: "./config.json") [$SGC_CONFIG]
   --github-token token                   GitHub token [$SGC_GITHUB_TOKEN]
   --gitlab-token token                   GitLab token [$SGC_GITLAB_TOKEN]
   --slack-token token                    Slack token [$SGC_SLACK_TOKEN]
   --slack-signing-secret signing-secret  Slack signing-secret [$SGC_SLACK_SIGNING_SECRET]
   --help, -h                             show help (default: false)

Develop / Test

~$ make build
~$ ./slack-git-compare

Build / Release

If you want to build and/or release your own version of slack-git-compare, you need the following prerequisites :

• git
• golang
• make
• goreleaser

~$ git clone git@github.com:mvisonneau/slack-git-compare.git && cd slack-git-compare

# Build the binaries locally
~$ make build

# Build the binaries and release them (you will need a GITHUB_TOKEN and to reconfigure .goreleaser.yml)
~$ make release

Contribute

Contributions are more than welcome! Feel free to submit a PR.