drone_plugin_temple

README

cli tools to init project fast

$ curl -L --fail https://raw.githubusercontent.com/bridgewwater/drone-plugin-temple/main/drone-plugin-temple
# let temp-drone-plugin file folder under $PATH
$ chmod +x temp-drone-plugin
# see how to use
$ temp-drone-plugin -h

for what

• this project used to drone CI

Contributing

We welcome community contributions to this project.

Please read Contributor Guide for more information on how to get started.

请阅读有关 贡献者指南 以获取更多如何入门的信息## Features

Features

• more perfect test case coverage
• more perfect benchmark case
• more see features/README.md

usage

• use this template, replace list below
  • github.com/bridgewwater/drone-plugin-temple to your package name
  • bridgewwater to your owner name
  • drone-plugin-temple to your project name

Pipeline Settings (.drone.yml)

1.x

steps:
  - name: drone-plugin-temple
    image: bridgewwater/drone-plugin-temple:latest
    pull: if-not-exists
    settings:
      debug: false
      webhook:
        # https://docs.drone.io/pipeline/environment/syntax/#from-secrets
        from_secret: webhook_token
      msg_type: your-message-type
      timeout_second: 10 # default 10
    when:
      event: # https://docs.drone.io/pipeline/exec/syntax/conditions/#by-event
        - promote
        - rollback
        - push
        - pull_request
        - tag
      status: # only support failure/success,  both open will send anything
        - failure
        # - success

install cli tools

# install at ${GOPATH}/bin
$ go install -v github.com/bridgewwater/drone-plugin-temple/cmd/drone-plugin-temple@latest
# install version v1.0.0
$ go install -v github.com/bridgewwater/drone-plugin-temple/cmd/drone-plugin-temple@v1.0.0

or download by github releases

env

• minimum go version: go 1.18
• change go 1.18, ^1.18, 1.18.10-buster, 1.18.10 to new go version

libs

lib	version
https://github.com/stretchr/testify	v1.8.4
https://github.com/sebdah/goldie	v2.5.3

• more see go.mod

dev

depends

in go mod project

# warning use private git host must set
# global set for once
# add private git host like github.com to evn GOPRIVATE
$ go env -w GOPRIVATE='github.com'
# use ssh proxy
# set ssh-key to use ssh as http
$ git config --global url."git@github.com:".insteadOf "https://github.com/"
# or use PRIVATE-TOKEN
# set PRIVATE-TOKEN as gitlab or gitea
$ git config --global http.extraheader "PRIVATE-TOKEN: {PRIVATE-TOKEN}"
# set this rep to download ssh as https use PRIVATE-TOKEN
$ git config --global url."ssh://github.com/".insteadOf "https://github.com/"

# before above global settings
# test version info
$ git ls-remote -q https://github.com/bridgewwater/drone-plugin-temple.git

# test depends see full version
$ go list -mod=readonly -v -m -versions github.com/bridgewwater/drone-plugin-temple
# or use last version add go.mod by script
$ echo "go mod edit -require=$(go list -mod=readonly -m -versions github.com/bridgewwater/drone-plugin-temple | awk '{print $1 "@" $NF}')"
$ echo "go mod vendor"

make init dep

• see help

$ make devHelp

• test code

add env then test

export PLUGIN_MSG_TYPE=post \
  export PLUGIN_WEBHOOK=7138d7b3-abc

$ make test testBenchmark

• full env example

export PLUGIN_MSG_TYPE= \
  export PLUGIN_WEBHOOK= \
  export DRONE_REPO=bridgewwater/drone-plugin-temple \
  export DRONE_REPO_NAME=drone-plugin-temple \
  export DRONE_REPO_NAMESPACE=bridgewwater \
  export DRONE_REMOTE_URL=https://github.com/bridgewwater/drone-plugin-temple \
  export DRONE_REPO_OWNER=bridgewwater \
  export DRONE_COMMIT_AUTHOR=bridgewwater \
  export DRONE_COMMIT_AUTHOR_AVATAR=  \
  export DRONE_COMMIT_AUTHOR_EMAIL=bridgewwatergmppt@gmail.com \
  export DRONE_COMMIT_BRANCH=main \
  export DRONE_COMMIT_LINK=https://github.com/bridgewwater/drone-plugin-temple/commit/68e3d62dd69f06077a243a1db1460109377add64 \
  export DRONE_COMMIT_SHA=68e3d62dd69f06077a243a1db1460109377add64 \
  export DRONE_COMMIT_REF=refs/heads/main \
  export DRONE_COMMIT_MESSAGE="mock message commit" \
  export DRONE_STAGE_STARTED=1674531206 \
  export DRONE_STAGE_FINISHED=1674532106 \
  export DRONE_BUILD_STATUS=success \
  export DRONE_BUILD_NUMBER=1 \
  export DRONE_BUILD_LINK=https://drone.xxx.com/bridgewwater/drone-plugin-temple/1 \
  export DRONE_BUILD_EVENT=push \
  export DRONE_BUILD_STARTED=1674531206 \
  export DRONE_BUILD_FINISHED=1674532206

• then run

$ make run

• ci to fast check

$ make ci

docker

# then test build as test/Dockerfile
$ make dockerTestRestartLatest
# if run error
# like this error
# err: missing webhook, please set webhook
#  fix env settings then test

# see run docker fast
$ make dockerTestRunLatest

# clean test build
$ make dockerTestPruneLatest

# see how to use
$ docker run --rm bridgewwater/drone-plugin-temple:latest -h

Documentation

Index

• Variables

Variables

var PackageJson string