gogit

command module
v0.0.7 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 31, 2023 License: MIT Imports: 2 Imported by: 0

README

codecov

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

  • GitHub
  • Gitlab (public or private)

Usage

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:

gogit checkout --pr 1

Send status to Git Provider

Below is an example of sending build status to a private Gitlab server:

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:

Argo workflow Executor

Install as an Argo workflow executor plugin:

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:

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:

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

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL