Update pipeline with Go code review (#25 )

Reviewed-on: https://codeberg.org/woodpecker-plugins/go-plugin/pulls/25 Co-authored-by: Lauris BH <lauris@nix.lv> Co-committed-by: Lauris BH <lauris@nix.lv>
Set usage text to not display default urfave cli one
2026-06-16 14:49:10 +08:00 · 2024-03-30 15:52:30 +00:00 · 2024-03-30 17:33:08 +02:00 · 2024-03-23 00:09:05 +00:00 · 2024-03-09 00:11:20 +00:00 · 2024-03-02 00:09:58 +00:00
12 changed files with 200 additions and 104 deletions
@@ -6,16 +6,28 @@ when:
      - 'renovate/*'

 variables:
-  - &golang "golang:1.21"
+  - &golang "golang:1.22"
+  - &golangci-lint "golangci/golangci-lint:v1.57-alpine"
+  - &reviewdog-golangci-lint "woodpeckerci/plugin-reviewdog-golangci-lint:1.57"

 steps:
  vendor:
    image: *golang
    commands: go mod vendor

+  review-go:
+    image: *reviewdog-golangci-lint
+    settings:
+      token:
+        from_secret: reviewdog_token
+    when:
+      event: pull_request
+
  lint:
-    image: golangci/golangci-lint:v1.55-alpine
+    image: *golangci-lint
    commands: golangci-lint run
+    when:
+      event: [push, tag, cron]

  test:
    image: *golang
@@ -41,7 +41,7 @@ type (
 	}
 )

-func currFlags() []cli.Flag {
+func commitFlags() []cli.Flag {
 	return []cli.Flag{
 		&cli.StringFlag{
 			Name:    "commit.sha",
@@ -106,7 +106,7 @@ func currFlags() []cli.Flag {
 	}
 }

-func currFromContext(c *cli.Context) Commit {
+func commitFromContext(c *cli.Context) Commit {
 	return Commit{
 		Sha:          c.String("commit.sha"),
 		Ref:          c.String("commit.ref"),
@@ -125,7 +125,7 @@ func currFromContext(c *cli.Context) Commit {
 	}
 }

-func prevFlags() []cli.Flag {
+func previousCommitFlags() []cli.Flag {
 	return []cli.Flag{
 		&cli.StringFlag{
 			Name:    "prev.commit.sha",
@@ -170,7 +170,7 @@ func prevFlags() []cli.Flag {
 	}
 }

-func prevFromContext(c *cli.Context) Commit {
+func previousCommitFromContext(c *cli.Context) Commit {
 	return Commit{
 		Sha:     c.String("prev.commit.sha"),
 		Ref:     c.String("prev.commit.ref"),
@@ -25,10 +25,11 @@ func Flags() []cli.Flag {
 	// Pipeline flags
 	flags = append(flags, repositoryFlags()...)
 	flags = append(flags, pipelineFlags()...)
-	flags = append(flags, currFlags()...)
-	flags = append(flags, prevFlags()...)
+	flags = append(flags, commitFlags()...)
+	flags = append(flags, previousCommitFlags()...)
 	flags = append(flags, stepFlags()...)
 	flags = append(flags, systemFlags()...)
+	flags = append(flags, forgeFlags()...)

 	// Plugin flags
 	flags = append(flags, loggingFlags()...)
@@ -0,0 +1,64 @@
+// Copyright 2023 Woodpecker Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package plugin
+
+import (
+	"github.com/urfave/cli/v2"
+)
+
+const (
+	ForgeTypeGitea     = "gitea"
+	ForgeTypeGitHub    = "github"
+	ForgeTypeGitLab    = "gitlab"
+	ForgeTypeBitbucket = "bitbucket"
+)
+
+// Forge defines metadata for integration with a forge.
+type Forge struct {
+	Type string `json:"type,omitempty"`
+	URL  string `json:"url,omitempty"`
+
+	// Deprecated: Please use URL instead.
+	Link string `json:"link,omitempty"`
+}
+
+func forgeFlags() []cli.Flag {
+	return []cli.Flag{
+		&cli.StringFlag{
+			Name:  "forge.type",
+			Usage: "forge type (gitea, github, gitlab, bitbucket)",
+			EnvVars: []string{
+				"CI_FORGE_TYPE",
+			},
+		},
+		&cli.StringFlag{
+			Name:    "forge.url",
+			Aliases: []string{"forge.link"},
+			Usage:   "forge url",
+			EnvVars: []string{
+				"CI_FORGE_URL",
+				"CI_FORGE_LINK",
+			},
+		},
+	}
+}
+
+func forgeFromContext(ctx *cli.Context) Forge {
+	return Forge{
+		Type: ctx.String("forge.type"),
+		Link: ctx.String("forge.url"),
+		URL:  ctx.String("forge.url"),
+	}
+}
@@ -4,10 +4,10 @@ go 1.19

 require (
 	github.com/joho/godotenv v1.5.1
-	github.com/rs/zerolog v1.31.0
-	github.com/stretchr/testify v1.8.4
-	github.com/urfave/cli/v2 v2.26.0
-	golang.org/x/net v0.19.0
+	github.com/rs/zerolog v1.32.0
+	github.com/stretchr/testify v1.9.0
+	github.com/urfave/cli/v2 v2.27.1
+	golang.org/x/net v0.22.0
 )

 require (
@@ -18,6 +18,6 @@ require (
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/russross/blackfriday/v2 v2.1.0 // indirect
 	github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 // indirect
-	golang.org/x/sys v0.15.0 // indirect
+	golang.org/x/sys v0.18.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )
@@ -1,76 +1,38 @@
-github.com/coreos/go-systemd/v22 v22.3.3-0.20220203105225-a9a7ef127534/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc=
 github.com/coreos/go-systemd/v22 v22.5.0/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc=
 github.com/cpuguy83/go-md2man/v2 v2.0.2 h1:p1EgwI/C7NhT0JmVkwCD2ZBK8j4aeHQX2pMHHBfMQ6w=
 github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
-github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA=
-github.com/joho/godotenv v1.4.0 h1:3l4+N6zfMWnkbPEXKng2o2/MR5mSwTrBih4ZEkkz1lg=
-github.com/joho/godotenv v1.4.0/go.mod h1:f4LDr5Voq0i2e/R5DDNOoa2zzDfwtkZa6DnEwAbqwq4=
 github.com/joho/godotenv v1.5.1 h1:7eLL/+HRGLY0ldzfGMeQkb7vMd0as4CfYvUVzLqw0N0=
 github.com/joho/godotenv v1.5.1/go.mod h1:f4LDr5Voq0i2e/R5DDNOoa2zzDfwtkZa6DnEwAbqwq4=
-github.com/mattn/go-colorable v0.1.12 h1:jF+Du6AlPIjs2BiUiQlKOX0rt3SujHxPnksPKZbaA40=
-github.com/mattn/go-colorable v0.1.12/go.mod h1:u5H1YNBxpqRaxsYJYSkiCWKzEfiAb1Gb520KVy5xxl4=
 github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA=
 github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg=
-github.com/mattn/go-isatty v0.0.14 h1:yVuAays6BHfxijgZPzw+3Zlu5yQgKGP2/hcQbHb7S9Y=
-github.com/mattn/go-isatty v0.0.14/go.mod h1:7GGIvUiUoEMVVmxf/4nioHXj79iQHKdU27kJ6hsGG94=
 github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
 github.com/mattn/go-isatty v0.0.19 h1:JITubQf0MOLdlGRuRq+jtsDlekdYPia9ZFsB8h/APPA=
 github.com/mattn/go-isatty v0.0.19/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
 github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
-github.com/rs/xid v1.4.0/go.mod h1:trrq9SKmegXys3aeAKXMUTdJsYXVwGY3RLcfgqegfbg=
 github.com/rs/xid v1.5.0/go.mod h1:trrq9SKmegXys3aeAKXMUTdJsYXVwGY3RLcfgqegfbg=
-github.com/rs/zerolog v1.28.0 h1:MirSo27VyNi7RJYP3078AA1+Cyzd2GB66qy3aUHvsWY=
-github.com/rs/zerolog v1.28.0/go.mod h1:NILgTygv/Uej1ra5XxGf82ZFSLk58MFGAUS2o6usyD0=
-github.com/rs/zerolog v1.31.0 h1:FcTR3NnLWW+NnTwwhFWiJSZr4ECLpqCm6QsEnyvbV4A=
-github.com/rs/zerolog v1.31.0/go.mod h1:/7mN4D5sKwJLZQ2b/znpjC3/GQWY/xaDXUM0kKWRHss=
+github.com/rs/zerolog v1.32.0 h1:keLypqrlIjaFsbmJOBdB/qvyF8KEtCWHwobLp5l/mQ0=
+github.com/rs/zerolog v1.32.0/go.mod h1:/7mN4D5sKwJLZQ2b/znpjC3/GQWY/xaDXUM0kKWRHss=
 github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
-github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
-github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
-github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
-github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
-github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
-github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk=
-github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
-github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=
-github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
-github.com/urfave/cli/v2 v2.23.7 h1:YHDQ46s3VghFHFf1DdF+Sh7H4RqhcM+t0TmZRJx4oJY=
-github.com/urfave/cli/v2 v2.23.7/go.mod h1:GHupkWPMM0M/sj1a2b4wUrWBPzazNrIjouW6fmdJLxc=
-github.com/urfave/cli/v2 v2.25.7 h1:VAzn5oq403l5pHjc4OhD54+XGO9cdKVL/7lDjF+iKUs=
-github.com/urfave/cli/v2 v2.25.7/go.mod h1:8qnjx1vcq5s2/wpsqoZFndg2CE5tNFyrTvS6SinrnYQ=
-github.com/urfave/cli/v2 v2.26.0 h1:3f3AMg3HpThFNT4I++TKOejZO8yU55t3JnnSr4S4QEI=
-github.com/urfave/cli/v2 v2.26.0/go.mod h1:8qnjx1vcq5s2/wpsqoZFndg2CE5tNFyrTvS6SinrnYQ=
+github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
+github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+github.com/urfave/cli/v2 v2.27.1 h1:8xSQ6szndafKVRmfyeUMxkNUJQMjL1F2zmsZ+qHpfho=
+github.com/urfave/cli/v2 v2.27.1/go.mod h1:8qnjx1vcq5s2/wpsqoZFndg2CE5tNFyrTvS6SinrnYQ=
 github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 h1:bAn7/zixMGCfxrRTfdpNzjtPYqr8smhKouy9mxVdGPU=
 github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673/go.mod h1:N3UwUGtsrSj3ccvlPHLoLsHnpR27oXr4ZE984MbSER8=
-golang.org/x/net v0.5.0 h1:GyT4nK/YDHSqa1c4753ouYCDajOYKTja9Xb/OHtgvSw=
-golang.org/x/net v0.5.0/go.mod h1:DivGGAXEgPSlEBzxGzZI+ZLohi+xUj054jfeKui00ws=
-golang.org/x/net v0.17.0 h1:pVaXccu2ozPjCXewfr1S7xza/zcXTity9cCdXQYSjIM=
-golang.org/x/net v0.17.0/go.mod h1:NxSsAGuq816PNPmqtQdLE42eU2Fs7NoRIZrHJAlaCOE=
-golang.org/x/net v0.18.0 h1:mIYleuAkSbHh0tCv7RvjL3F6ZVbLjq4+R7zbOn3Kokg=
-golang.org/x/net v0.18.0/go.mod h1:/czyP5RqHAH4odGYxBJ1qz0+CE5WZ+2j1YgoEo8F2jQ=
-golang.org/x/net v0.19.0 h1:zTwKpTd2XuCqf8huc7Fo2iSy+4RHPd10s4KzeTnVr1c=
-golang.org/x/net v0.19.0/go.mod h1:CfAk/cbD4CthTvqiEl8NpboMuiuOYsAr/7NOjZJtv1U=
-golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.0.0-20210927094055-39ccf1dd6fa6/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
+golang.org/x/net v0.22.0 h1:9sGLhx7iRIHEiX0oAJ3MRZMUCElJgy7Br1nO+AMN3Tc=
+golang.org/x/net v0.22.0/go.mod h1:JKghWKKOSdJwpW2GEx0Ja7fmaKnMsbu+MWVZTokSYmg=
 golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.4.0 h1:Zr2JFtRQNX3BCZ8YtxRE9hNJYC8J6I1MVbMg6owUp18=
-golang.org/x/sys v0.4.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.12.0 h1:CM0HF96J0hcLAwsHPJZjfdNzs0gftsLfgKt57wWHJ0o=
 golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.13.0 h1:Af8nKPmuFypiUBjVoU9V20FiaFXOcuZI21p0ycVYYGE=
-golang.org/x/sys v0.13.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.14.0 h1:Vz7Qs629MkJkGyHxUlRHizWJRG2j8fbQKjELVSNhy7Q=
-golang.org/x/sys v0.14.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
-golang.org/x/sys v0.15.0 h1:h48lPFYpsTvQJZF4EKyI4aLHaev3CxivZmv7yZig9pc=
-golang.org/x/sys v0.15.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/sys v0.18.0 h1:DBdB3niSjOA/O0blCZBqDefyWNYveAYMNF1Wum0DYQ4=
+golang.org/x/sys v0.18.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
-gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
@@ -20,22 +20,36 @@ import (

 // Metadata defines runtime metadata.
 type Metadata struct {
-	Repository Repository `json:"repo,omitempty"`
-	Pipeline   Pipeline   `json:"curr,omitempty"`
-	Curr       Commit     `json:"commit,omitempty"`
-	Prev       Commit     `json:"prev,omitempty"`
-	Step       Step       `json:"step,omitempty"`
-	System     System     `json:"sys,omitempty"`
+	Repository     Repository `json:"repo,omitempty"`
+	Pipeline       Pipeline   `json:"curr,omitempty"`
+	Commit         Commit     `json:"commit,omitempty"`
+	PreviousCommit Commit     `json:"previous_commit,omitempty"`
+	Step           Step       `json:"step,omitempty"`
+	System         System     `json:"sys,omitempty"`
+	Forge          Forge      `json:"forge,omitempty"`
+
+	// Deprecated: Please use Commit instead.
+	Curr Commit
+
+	// Deprecated: Please use PreviousCommit instead.
+	Prev Commit `json:"prev,omitempty"`
 }

 // MetadataFromContext creates a Metadata from the cli.Context.
 func MetadataFromContext(ctx *cli.Context) Metadata {
+	commit := commitFromContext(ctx)
+	previousCommit := previousCommitFromContext(ctx)
+
 	return Metadata{
-		Repository: repositoryFromContext(ctx),
-		Pipeline:   pipelineFromContext(ctx),
-		Curr:       currFromContext(ctx),
-		Prev:       prevFromContext(ctx),
-		Step:       stepFromContext(ctx),
-		System:     systemFromContext(ctx),
+		Repository:     repositoryFromContext(ctx),
+		Pipeline:       pipelineFromContext(ctx),
+		Commit:         commit,
+		PreviousCommit: previousCommit,
+		Step:           stepFromContext(ctx),
+		System:         systemFromContext(ctx),
+		Forge:          forgeFromContext(ctx),
+
+		Curr: commit,
+		Prev: previousCommit,
 	}
 }
@@ -48,7 +48,7 @@ func testMetadata() map[string]string {
 		"CI_COMMIT_URL":           "https://codeberg.org/woodpecker-plugins/go-plugin/commit/a1b2c3d4",
 		// Build
 		"CI_PIPELINE_NUMBER":  "1",
-		"CI_PIPELINE_EVENT":   "push",
+		"CI_PIPELINE_EVENT":   EventTypePush,
 		"CI_PIPELINE_URL":     "https://ci.woodpecker-ci.org/woodpecker-ci/woodpecker/1",
 		"CI_PIPELINE_STATUS":  "running",
 		"CI_PIPELINE_CREATED": "1611234567",
@@ -63,6 +63,9 @@ func testMetadata() map[string]string {
 		"CI_SYSTEM_URL":     "https://ci.woodpecker-ci.org",
 		"CI_SYSTEM_VERSION": "1.0.0",
 		"CI_SYSTEM_HOST":    "woodpecker-ci.org",
+		// Forge
+		"CI_FORGE_TYPE": ForgeTypeGitea,
+		"CI_FORGE_URL":  "https://codeberg.org",
 	}
 }

@@ -82,7 +85,7 @@ func TestMetadata(t *testing.T) {
 	// Repository
 	assert.Equal(t, "woodpecker", plugin.Metadata.Repository.Name)
 	assert.Equal(t, "woodpecker-ci", plugin.Metadata.Repository.Owner)
-	assert.Equal(t, "https://codeberg.org/woodpecker-plugins/go-plugin", plugin.Metadata.Repository.Link)
+	assert.Equal(t, "https://codeberg.org/woodpecker-plugins/go-plugin", plugin.Metadata.Repository.URL)
 	assert.Equal(t, "https://codeberg.org/woodpecker-plugins/go-plugin.git", plugin.Metadata.Repository.CloneURL)
 	assert.Equal(t, "main", plugin.Metadata.Repository.Branch)
 	assert.False(t, plugin.Metadata.Repository.Private)
@@ -99,8 +102,8 @@ func TestMetadata(t *testing.T) {

 	// Pipeline
 	assert.Equal(t, int64(1), plugin.Metadata.Pipeline.Number)
-	assert.Equal(t, "push", plugin.Metadata.Pipeline.Event)
-	assert.Equal(t, "https://ci.woodpecker-ci.org/woodpecker-ci/woodpecker/1", plugin.Metadata.Pipeline.Link)
+	assert.Equal(t, EventTypePush, plugin.Metadata.Pipeline.Event)
+	assert.Equal(t, "https://ci.woodpecker-ci.org/woodpecker-ci/woodpecker/1", plugin.Metadata.Pipeline.URL)
 	assert.Equal(t, "running", plugin.Metadata.Pipeline.Status)
 	assert.Equal(t, time.Unix(1611234567, 0), plugin.Metadata.Pipeline.Created)
 	assert.Equal(t, time.Unix(1611234567, 0), plugin.Metadata.Pipeline.Started)
@@ -111,7 +114,11 @@ func TestMetadata(t *testing.T) {

 	// System
 	assert.Equal(t, "woodpecker", plugin.Metadata.System.Name)
-	assert.Equal(t, "https://ci.woodpecker-ci.org", plugin.Metadata.System.Link)
+	assert.Equal(t, "https://ci.woodpecker-ci.org", plugin.Metadata.System.URL)
 	assert.Equal(t, "1.0.0", plugin.Metadata.System.Version)
 	assert.Equal(t, "woodpecker-ci.org", plugin.Metadata.System.Host)
+
+	// Forge
+	assert.Equal(t, ForgeTypeGitea, plugin.Metadata.Forge.Type)
+	assert.Equal(t, "https://codeberg.org", plugin.Metadata.Forge.URL)
 }
@@ -20,17 +20,29 @@ import (
 	"github.com/urfave/cli/v2"
 )

+const (
+	EventTypePush        = "push"
+	EventTypePullRequest = "pull_request"
+	EventTypeTag         = "tag"
+	EventTypeDeployment  = "deployment"
+	EventTypeCron        = "cron"
+	EventTypeManual      = "manual"
+)
+
 // Pipeline defines runtime metadata for a pipeline.
 type Pipeline struct {
 	Number       int64     `json:"number,omitempty"`
 	Status       string    `json:"status,omitempty"`
 	Event        string    `json:"event,omitempty"`
-	Link         string    `json:"link,omitempty"`
+	URL          string    `json:"url,omitempty"`
 	DeployTarget string    `json:"target,omitempty"`
 	Created      time.Time `json:"created,omitempty"`
 	Started      time.Time `json:"started,omitempty"`
 	Finished     time.Time `json:"finished,omitempty"`
 	Parent       int64     `json:"parent,omitempty"`
+
+	// Deprecated: Please use URL instead.
+	Link string `json:"link,omitempty"`
 }

 func pipelineFlags() []cli.Flag {
@@ -60,8 +72,9 @@ func pipelineFlags() []cli.Flag {
 			},
 		},
 		&cli.StringFlag{
-			Name:  "pipeline.link",
-			Usage: "pipeline link",
+			Name:    "pipeline.url",
+			Aliases: []string{"pipeline.link"},
+			Usage:   "pipeline url",
 			EnvVars: []string{
 				"CI_PIPELINE_URL",
 				"CI_PIPELINE_LINK",
@@ -116,7 +129,8 @@ func pipelineFromContext(c *cli.Context) Pipeline {
 		Number:       c.Int64("pipeline.number"),
 		Status:       c.String("pipeline.status"),
 		Event:        c.String("pipeline.event"),
-		Link:         c.String("pipeline.link"),
+		URL:          c.String("pipeline.url"),
+		Link:         c.String("pipeline.url"),
 		DeployTarget: c.String("pipeline.deploy-target"),
 		Created:      time.Unix(c.Int64("pipeline.created"), 0),
 		Started:      time.Unix(c.Int64("pipeline.started"), 0),
@@ -58,6 +58,7 @@ func New(opt Options) *Plugin {

 	app := &cli.App{
 		Name:        opt.Name,
+		Usage:       "Run the Woodpecker CI plugin",
 		Description: opt.Description,
 		Version:     opt.Version,
 		Flags:       append(opt.Flags, Flags()...),
@@ -20,16 +20,28 @@ import (

 // Repository defines runtime metadata for a repository.
 type Repository struct {
-	Name     string `json:"name,omitempty"`
-	Owner    string `json:"owner,omitempty"`
-	Link     string `json:"link,omitempty"`
-	CloneURL string `json:"clone_url,omitempty"`
-	Private  bool   `json:"private,omitempty"`
-	Branch   string `json:"default_branch,omitempty"`
+	RemoteID      string `json:"remote_id,omitempty"`
+	Name          string `json:"name,omitempty"`
+	Owner         string `json:"owner,omitempty"`
+	Link          string `json:"link,omitempty"`
+	URL           string `json:"url,omitempty"`
+	CloneURL      string `json:"clone_url,omitempty"`
+	Private       bool   `json:"private,omitempty"`
+	DefaultBranch string `json:"default_branch,omitempty"`
+
+	// Deprecated: Please use DefaultBranch instead.
+	Branch string
 }

 func repositoryFlags() []cli.Flag {
 	return []cli.Flag{
+		&cli.StringFlag{
+			Name:  "repo.remote-id",
+			Usage: "repo remote id",
+			EnvVars: []string{
+				"CI_REPO_REMOTE_ID",
+			},
+		},
 		&cli.StringFlag{
 			Name:  "repo.name",
 			Usage: "repo name",
@@ -47,8 +59,9 @@ func repositoryFlags() []cli.Flag {
 			},
 		},
 		&cli.StringFlag{
-			Name:  "repo.link",
-			Usage: "repo link",
+			Name:    "repo.url",
+			Aliases: []string{"repo.link"},
+			Usage:   "repo url",
 			EnvVars: []string{
 				"CI_REPO_URL",
 				"CI_REPO_LINK",
@@ -84,11 +97,14 @@ func repositoryFlags() []cli.Flag {

 func repositoryFromContext(c *cli.Context) Repository {
 	return Repository{
-		Name:     c.String("repo.name"),
-		Owner:    c.String("repo.owner"),
-		Link:     c.String("repo.link"),
-		CloneURL: c.String("repo.clone-url"),
-		Private:  c.Bool("repo.private"),
-		Branch:   c.String("repo.default-branch"),
+		RemoteID:      c.String("repo.remote-id"),
+		Name:          c.String("repo.name"),
+		Owner:         c.String("repo.owner"),
+		URL:           c.String("repo.url"),
+		Link:          c.String("repo.url"),
+		CloneURL:      c.String("repo.clone-url"),
+		Private:       c.Bool("repo.private"),
+		Branch:        c.String("repo.default-branch"),
+		DefaultBranch: c.String("repo.default-branch"),
 	}
 }
@@ -24,9 +24,12 @@ import (
 type System struct {
 	Name     string `json:"name,omitempty"`
 	Host     string `json:"host,omitempty"`
-	Link     string `json:"link,omitempty"`
 	Platform string `json:"arch,omitempty"`
 	Version  string `json:"version,omitempty"`
+	URL      string `json:"url,omitempty"`
+
+	// Deprecated: Please use URL instead.
+	Link string `json:"link,omitempty"`
 }

 func systemFlags() []cli.Flag {
@@ -48,8 +51,9 @@ func systemFlags() []cli.Flag {
 			},
 		},
 		&cli.StringFlag{
-			Name:  "system.link",
-			Usage: "system link",
+			Name:    "system.url",
+			Aliases: []string{"system.link"},
+			Usage:   "system url",
 			EnvVars: []string{
 				"CI_SYSTEM_URL",
 				"CI_SYSTEM_LINK",
@@ -75,19 +79,20 @@ func systemFlags() []cli.Flag {
 }

 func systemFromContext(ctx *cli.Context) System {
-	link := ctx.String("system.link")
+	url := ctx.String("system.url")
 	host := ctx.String("system.host")
-	if link == "" && host != "" {
-		// Alternative link format used by Drone.
+	if url == "" && host != "" {
+		// Alternative url format used by Drone.
 		proto := os.Getenv("DRONE_SYSTEM_PROTO")
 		if proto != "" {
-			link = proto + "://" + host
+			url = proto + "://" + host
 		}
 	}
 	return System{
 		Name:     ctx.String("system.name"),
 		Host:     host,
-		Link:     link,
+		URL:      url,
+		Link:     url,
 		Platform: ctx.String("system.arch"),
 		Version:  ctx.String("system.version"),
 	}
Author	SHA1	Message	Date
Lauris BH	ca1f8e48fe	Update pipeline with Go code review (#25 ) Reviewed-on: https://codeberg.org/woodpecker-plugins/go-plugin/pulls/25 Co-authored-by: Lauris BH <lauris@nix.lv> Co-committed-by: Lauris BH <lauris@nix.lv>	2024-03-30 15:52:30 +00:00
Lauris BH	b67c23ab79	Set usage text to not display default urfave cli one	2024-03-30 17:33:08 +02:00
woodpecker-bot	f6037e6127	chore(deps): update golangci/golangci-lint docker tag to v1.57	2024-03-23 00:09:05 +00:00
woodpecker-bot	fa7f39a739	fix(deps): update module golang.org/x/net to v0.22.0	2024-03-09 00:11:20 +00:00
woodpecker-bot	0ab802ca5b	fix(deps): update module github.com/stretchr/testify to v1.9.0	2024-03-02 00:09:58 +00:00
anbraten	090b4571b4	Add & update some env data (#24 ) - Some renamings to be more descriptive - link -> url - deprecated all old properties closes #22 Co-authored-by: Anbraten <6918444+anbraten@users.noreply.github.com> Reviewed-on: https://codeberg.org/woodpecker-plugins/go-plugin/pulls/24 Reviewed-by: 6543 <6543@obermui.de> Co-authored-by: anbraten <anbraten@noreply.codeberg.org> Co-committed-by: anbraten <anbraten@noreply.codeberg.org>	2024-02-15 18:53:26 +00:00
woodpecker-bot	6a59bd9561	fix(deps): update module golang.org/x/net to v0.21.0	2024-02-08 11:41:26 +00:00
woodpecker-bot	f3134af984	chore(deps): update golangci/golangci-lint docker tag to v1.56	2024-02-08 11:06:03 +00:00
woodpecker-bot	890edaf1c3	chore(deps): update golang docker tag to v1.22	2024-02-08 10:36:05 +00:00
woodpecker-bot	a969947601	fix(deps): update module github.com/rs/zerolog to v1.32.0	2024-02-05 00:10:14 +00:00
woodpecker-bot	0ae47cb04a	fix(deps): update module golang.org/x/net to v0.20.0	2024-01-09 00:09:10 +00:00
woodpecker-bot	125fb101dc	fix(deps): update module github.com/urfave/cli/v2 to v2.27.1	2023-12-31 00:18:25 +00:00
woodpecker-bot	7b81f9a203	fix(deps): update module github.com/urfave/cli/v2 to v2.27.0	2023-12-27 00:10:03 +00:00
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