Woodpecker CI plugin library
Go to file
Lauris BH 93da4f40e1 Add Forge metadata (#20)
Adds support for loading Forge metadata from env variables

Reviewed-on: https://codeberg.org/woodpecker-plugins/go-plugin/pulls/20
Reviewed-by: qwerty287 <qwerty287@noreply.codeberg.org>
Co-authored-by: Lauris BH <lauris@nix.lv>
Co-committed-by: Lauris BH <lauris@nix.lv>
2023-12-10 20:27:57 +00:00
.woodpecker.yaml also run tests on renovate/ branches 2023-11-08 20:04:23 +01:00
LICENSE Initial implementation 2023-01-08 04:53:03 +02:00
README.md fix: make readme example compile (#17) 2023-11-15 17:33:12 +00:00
commit.go Initial implementation 2023-01-08 04:53:03 +02:00
flags.go Add Forge metadata (#20) 2023-12-10 20:27:57 +00:00
forge.go Add Forge metadata (#20) 2023-12-10 20:27:57 +00:00
go.mod fix(deps): update module github.com/urfave/cli/v2 to v2.26.0 2023-12-04 00:11:20 +00:00
go.sum fix(deps): update module github.com/urfave/cli/v2 to v2.26.0 2023-12-04 00:11:20 +00:00
http.go Initial implementation 2023-01-08 04:53:03 +02:00
logger.go Fix to not log time in output (#3) 2023-01-09 12:33:18 +00:00
metadata.go Add Forge metadata (#20) 2023-12-10 20:27:57 +00:00
metadata_test.go Add Forge metadata (#20) 2023-12-10 20:27:57 +00:00
pipeline.go Add Forge metadata (#20) 2023-12-10 20:27:57 +00:00
plugin.go Initial implementation 2023-01-08 04:53:03 +02:00
plugin_test.go Initial implementation 2023-01-08 04:53:03 +02:00
renovate.json Configure Renovate (#4) 2023-10-16 16:52:34 +00:00
repo.go Fix support for woodpecker 2.0.0 (#19) 2023-12-07 10:45:09 +00:00
step.go Initial implementation 2023-01-08 04:53:03 +02:00
system.go Fix support for woodpecker 2.0.0 (#19) 2023-12-07 10:45:09 +00:00

README.md

Library for creating Woodpecker CI plugins

Provides basic structure and helpers to load Woodpecker CI environment variables while also supporting reading Drone CI environment variables where available.

Adds logging support based on zerolog library and allows configurable HTTP client library.

Builtin settings

Settings Name Environment variable Default Description
log_level - info Sets log level (panic, fatal, error, warn, info, debug, trace)
skip_verify - false -
SOCKS_PROXY none SOCKS5 proxy to use for connections
SOCKS_PROXY_OFF none Do not use SOCKS5 proxy

Creating plugin

package main

import (
	"context"

	"codeberg.org/woodpecker-plugins/go-plugin"
	"github.com/rs/zerolog/log"
	"github.com/urfave/cli/v2"
)

type Settings struct {
	// TODO: Plugin settings
	SampleFlag string
}

type Plugin struct {
	*plugin.Plugin
	Settings *Settings
}

func (p *Plugin) Flags() []cli.Flag {
	return []cli.Flag{
		// TODO: Add flags
		&cli.StringFlag{
			Name:        "sample.flag",
			Usage:       "sample flag",
			EnvVars:     []string{"PLUGIN_SAMPLE_FLAG"},
			Destination: &p.Settings.SampleFlag,
		},
	}
}

func (p *Plugin) Execute(ctx context.Context) error {
	// TODO: Implement execution
	log.Debug().Msg("executed")
	return nil
}

func main() {
	p := &Plugin{
		Settings: &Settings{},
	}

	p.Plugin = plugin.New(plugin.Options{
		Name:        "sample-plugin",
		Description: "Sample plugin",
		Flags:       p.Flags(),
		Execute:     p.Execute,
	})

	p.Run()
}