# gogit

**Repository Path**: linuxsuren/gogit

## Basic Information

- **Project Name**: gogit
- **Description**: https://github.com/linuxsuren/gogit
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://github.com/linuxsuren/gogit
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2023-04-01
- **Last Updated**: 2025-03-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[![codecov](https://codecov.io/gh/LinuxSuRen/gogit/branch/master/graph/badge.svg?token=mnFyeD2IQ7)](https://codecov.io/gh/LinuxSuRen/gogit)

`gogit` could send the build status to different git providers. Such as:

* GitHub
* Gitlab (public or private)

## Usage

### Generate commit message with AI

```shell
export AI_PROVIDER=your-one-api-server-address
export ONEAPI_TOKEN=your-one-api-token

gogit commit
```

It supports [one-api](https://github.com/songquanpeng/one-api) only.

### Checkout to branch or PR
Ideally, `gogit` could checkout to your branch or PR in any kind of git repository.

You can run the following command in a git repository directory:

```shell
gogit checkout --pr 1
```

### Send status to Git Provider
Below is an example of sending build status to a private Gitlab server:

```shell
gogit status --provider gitlab \
  --server http://10.121.218.82:6080 \
  --repo yaml-readme \
  --pr 1 \
  --username linuxsuren \
  --token h-zez9CWzyzykbLoS53s
```

Or in the following use cases:

* [Tekton Task](https://hub.tekton.dev/tekton/task/gogit)

### Send a notification to DingDing
Below is an example of sending a notification to DingDing based on the Gitlab/GitHub pull request author/reviewers/assignees:

```shell
gogit pr --provider gitlab \
  --server http://10.121.218.82:6080 \
  --repo yaml-readme \
  --pr 1 \
  --username linuxsuren \
  --token h-zez9CWzyzykbLoS53s \
  --msg 'workflow done' \
  --dingding-tokens linuxsuren=dingdingtoken
```

## Argo workflow Executor
Install as an Argo workflow executor plugin:

```shell
cat <<EOF | kubectl apply -f -
---
apiVersion: v1
kind: ServiceAccount
metadata:
  name: gogit-executor-plugin
  namespace: default
---
apiVersion: v1
data:
  sidecar.automountServiceAccountToken: "true"
  sidecar.container: |
    args:
    - status
    - --provider
    - gitlab
    - --target
    - http://argo.argo-server.svc:2746                        # should be an external address
    - --create-comment=true                                   # create a comment to show the status of Workflow
    image: ghcr.io/linuxsuren/workflow-executor-gogit:master
    command:
    - workflow-executor-gogit
    name: gogit-executor-plugin
    ports:
    - containerPort: 3001
    resources:
      limits:
        cpu: 500m
        memory: 128Mi
      requests:
        cpu: 250m
        memory: 64Mi
    securityContext:
      allowPrivilegeEscalation: true
      runAsNonRoot: true
      runAsUser: 65534
kind: ConfigMap
metadata:
  creationTimestamp: null
  labels:
    workflows.argoproj.io/configmap-type: ExecutorPlugin
  name: gogit-executor-plugin
  namespace: argo
EOF
```

then, create a WorkflowTemplate:
```shell
cat <<EOF | kubectl apply -f -
apiVersion: argoproj.io/v1alpha1
kind: WorkflowTemplate
metadata:
  name: plugin
  namespace: default
spec:
  entrypoint: main
  hooks:
    exit:
      template: status
    all:
      template: status
      expression: "true"
  templates:
  - container:
      args:
        - search
        - kubectl
      command:
        - hd
      image: ghcr.io/linuxsuren/hd:v0.0.70
    name: main
  - name: status
    plugin:
      gogit-executor-plugin:
        owner: linuxsuren
        repo: test
        pr: "3"
        label: test
EOF
cat <<EOF | kubectl create -f -
apiVersion: argoproj.io/v1alpha1
kind: Workflow
metadata:
  generateName: plugin
  namespace: default
spec:
  workflowTemplateRef:
    name: plugin
EOF
```

It could create (and update) a comment on target pull request to show the status of the Workflow. See also:

```yaml
hello-world is Succeeded. It takes 3m30.19239846s. Please check log output from [here](https://10.121.218.184:30298/workflows/default/hello-world-r2lqm).

| Stage | Status | Duration |
|---|---|---|
| test | Succeeded | 38s |
| scan | Succeeded | 54s |
| build | Succeeded | 2m54s |
| clone | Succeeded | 26s |
| check | Succeeded | 33s |
| build(0) | Succeeded | 2m44s |


Comment from [gogit](https://github.com/linuxsuren/gogit).
```

## TODO
* Support more git providers

## Thanks
Thanks to these open source projects, they did a lot of important work.
* github.com/jenkins-x/go-scm
* github.com/spf13/cobra