Add support for release event (Github, Gitea, Gitlab)

cli/secret/secret_add.go

@@ -77,5 +77,6 @@ func secretCreate(c *cli.Context) error {
 var defaultSecretEvents = []string{
 	woodpecker.EventPush,
 	woodpecker.EventTag,
+	woodpecker.EventRelease,
 	woodpecker.EventDeploy,
 }

cmd/server/flags.go

@@ -270,6 +270,12 @@ var flags = []cli.Flag{
 		Name:    "github-skip-verify",
 		Usage:   "github skip ssl verification",
 	},
+	&cli.StringFlag{
+		EnvVars: []string{"WOODPECKER_GITHUB_RELEASE_ACTIONS"},
+		Name:    "github-release-actions",
+		Usage:   "On which actions to trigger a release pipeline",
+		Value:   "prereleased, released",
+	},
 	//
 	// Gogs
 	//

cmd/server/setup.go

@@ -19,6 +19,7 @@ import (
 	"fmt"
 	"net/url"
 	"os"
+	"regexp"
 	"strings"
 	"time"
 
@@ -267,13 +268,19 @@ func setupGitlab(c *cli.Context) (remote.Remote, error) {
 
 // helper function to setup the GitHub remote from the CLI arguments.
 func setupGithub(c *cli.Context) (remote.Remote, error) {
+	releaseActions := regexp.
+		MustCompile(`[\s,]+`).
+		Split(c.String("github-release-actions"), -1)
+
 	opts := github.Opts{
-		URL:        c.String("github-server"),
-		Client:     c.String("github-client"),
-		Secret:     c.String("github-secret"),
-		SkipVerify: c.Bool("github-skip-verify"),
-		MergeRef:   c.Bool("github-merge-ref"),
+		URL:            c.String("github-server"),
+		Client:         c.String("github-client"),
+		Secret:         c.String("github-secret"),
+		SkipVerify:     c.Bool("github-skip-verify"),
+		MergeRef:       c.Bool("github-merge-ref"),
+		ReleaseActions: releaseActions,
 	}
+
 	log.Trace().Msgf("Remote (github) opts: %#v", opts)
 	return github.New(opts)
 }

docs/docs/30-administration/11-vcs/10-overview.md

@@ -8,6 +8,7 @@
 | Event: Tag | :white_check_mark: | :white_check_mark: | :white_check_mark: |
 | Event: Pull-Request | :white_check_mark: | :white_check_mark: | :white_check_mark: |
 | Event: Deploy | :white_check_mark: | :x: | :x: |
+| Event: Release | :white_check_mark: | :x: | :x: |
 | OAuth | :white_check_mark: | :white_check_mark: | :white_check_mark: |
 | [Multi pipeline](/docs/usage/multi-pipeline) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :x: | :x: | :x: | :x: |
 | [when.path filter](/docs/usage/conditional-execution#path) | :white_check_mark: | :white_check_mark:¹ | :white_check_mark: | :x: | :x: | :x: | :x: |

docs/docs/30-administration/11-vcs/20-github.md

@@ -32,41 +32,55 @@ Please use this screenshot for reference:
 This is a full list of configuration options. Please note that many of these options use default configuration values that should work for the majority of installations.
 
 ### `WOODPECKER_GITHUB`
+
 > Default: `false`
 
 Enables the GitHub driver.
 
 ### `WOODPECKER_GITHUB_URL`
+
 > Default: `https://github.com`
 
 Configures the GitHub server address.
 
 ### `WOODPECKER_GITHUB_CLIENT`
+
 > Default: empty
 
 Configures the GitHub OAuth client id. This is used to authorize access.
 
 ### `WOODPECKER_GITHUB_CLIENT_FILE`
+
 > Default: empty
 
 Read the value for `WOODPECKER_GITHUB_CLIENT` from the specified filepath
 
 ### `WOODPECKER_GITHUB_SECRET`
+
 > Default: empty
 
 Configures the GitHub OAuth client secret. This is used to authorize access.
 
 ### `WOODPECKER_GITHUB_SECRET_FILE`
+
 > Default: empty
 
 Read the value for `WOODPECKER_GITHUB_SECRET` from the specified filepath
 
 ### `WOODPECKER_GITHUB_MERGE_REF`
+
 > Default: `true`
 
 TODO
 
 ### `WOODPECKER_GITHUB_SKIP_VERIFY`
+
 > Default: `false`
 
 Configure if SSL verification should be skipped.
+
+### `WOODPECKER_GITHUB_RELEASE_ACTIONS`
+
+> Default: `released, prereleased`
+
+The actions to allow on release (trigger), comma seperated.

pipeline/frontend/metadata.go

@@ -10,10 +10,11 @@ import (
 
 // Event types corresponding to scm hooks.
 const (
-	EventPush   = "push"
-	EventPull   = "pull_request"
-	EventTag    = "tag"
-	EventDeploy = "deployment"
+	EventPush    = "push"
+	EventPull    = "pull_request"
+	EventTag     = "tag"
+	EventDeploy  = "deployment"
+	EventRelease = "release"
 )
 
 type (
@@ -203,7 +204,7 @@ func (m *Metadata) Environ() map[string]string {
 		"CI_TAG":                     "",                                   // use CI_COMMIT_TAG
 		"CI_PULL_REQUEST":            "",                                   // use CI_COMMIT_PULL_REQUEST
 	}
-	if m.Curr.Event == EventTag {
+	if m.Curr.Event == EventTag || m.Curr.Event == EventRelease {
 		params["CI_COMMIT_TAG"] = strings.TrimPrefix(m.Curr.Commit.Ref, "refs/tags/")
 		params["CI_TAG"] = params["CI_COMMIT_TAG"]
 	}

server/api/hook.go

@@ -102,7 +102,11 @@ func PostHook(c *gin.Context) {
 	// wrapped in square brackets appear in the commit message
 	skipMatch := skipRe.FindString(build.Message)
 	if len(skipMatch) > 0 {
-		msg := fmt.Sprintf("ignoring hook: %s found in %s", skipMatch, build.Commit)
+		ref := build.Commit
+		if len(ref) == 0 {
+			ref = build.Ref
+		}
+		msg := fmt.Sprintf("ignoring hook: %s found in %s", skipMatch, ref)
 		log.Debug().Msg(msg)
 		c.String(http.StatusNoContent, msg)
 		return

server/model/const.go

@@ -17,15 +17,16 @@ package model
 type WebhookEvent string
 
 const (
-	EventPush   WebhookEvent = "push"
-	EventPull   WebhookEvent = "pull_request"
-	EventTag    WebhookEvent = "tag"
-	EventDeploy WebhookEvent = "deployment"
+	EventPush    WebhookEvent = "push"
+	EventPull    WebhookEvent = "pull_request"
+	EventTag     WebhookEvent = "tag"
+	EventDeploy  WebhookEvent = "deployment"
+	EventRelease WebhookEvent = "release"
 )
 
 func ValidateWebhookEvent(s WebhookEvent) bool {
 	switch s {
-	case EventPush, EventPull, EventTag, EventDeploy:
+	case EventPush, EventPull, EventTag, EventDeploy, EventRelease:
 		return true
 	default:
 		return false

server/remote/gitea/fixtures/hooks.go

@@ -157,3 +157,79 @@ const HookPullRequest = `{
       "avatar_url": "https://secure.gravatar.com/avatar/8c58a0be77ee441bb8f8595b7f1b4e87"
     }
 }`
+
+const HookRelease = `
+{
+  "action": "published",
+  "release": {
+    "id": 48,
+    "tag_name": "0.0.5",
+    "target_commitish": "main",
+    "name": "Version 0.0.5",
+    "body": "",
+    "url": "https://git.xxx/api/v1/repos/anbraten/demo/releases/48",
+    "html_url": "https://git.xxx/anbraten/demo/releases/tag/0.0.5",
+    "tarball_url": "https://git.xxx/anbraten/demo/archive/0.0.5.tar.gz",
+    "zipball_url": "https://git.xxx/anbraten/demo/archive/0.0.5.zip",
+    "draft": false,
+    "prerelease": false,
+    "created_at": "2022-02-09T20:23:05Z",
+    "published_at": "2022-02-09T20:23:05Z",
+    "author": {"id":1,"login":"anbraten","full_name":"Anton Bracke","email":"anbraten@noreply.xxx","avatar_url":"https://git.xxx/user/avatar/anbraten/-1","language":"","is_admin":false,"last_login":"0001-01-01T00:00:00Z","created":"2018-03-21T10:04:48Z","restricted":false,"active":false,"prohibit_login":false,"location":"world","website":"https://xxx","description":"","visibility":"public","followers_count":1,"following_count":1,"starred_repos_count":1,"username":"anbraten"},
+    "assets": []
+  },
+  "repository": {
+    "id": 77,
+    "owner": {"id":1,"login":"anbraten","full_name":"Anton Bracke","email":"anbraten@noreply.xxx","avatar_url":"https://git.xxx/user/avatar/anbraten/-1","language":"","is_admin":false,"last_login":"0001-01-01T00:00:00Z","created":"2018-03-21T10:04:48Z","restricted":false,"active":false,"prohibit_login":false,"location":"world","website":"https://xxx","description":"","visibility":"public","followers_count":1,"following_count":1,"starred_repos_count":1,"username":"anbraten"},
+    "name": "demo",
+    "full_name": "anbraten/demo",
+    "description": "",
+    "empty": false,
+    "private": true,
+    "fork": false,
+    "template": false,
+    "parent": null,
+    "mirror": false,
+    "size": 59,
+    "html_url": "https://git.xxx/anbraten/demo",
+    "ssh_url": "ssh://git@git.xxx:22/anbraten/demo.git",
+    "clone_url": "https://git.xxx/anbraten/demo.git",
+    "original_url": "",
+    "website": "",
+    "stars_count": 0,
+    "forks_count": 1,
+    "watchers_count": 1,
+    "open_issues_count": 2,
+    "open_pr_counter": 2,
+    "release_counter": 4,
+    "default_branch": "main",
+    "archived": false,
+    "created_at": "2021-08-30T20:54:13Z",
+    "updated_at": "2022-01-09T01:29:23Z",
+    "permissions": {
+      "admin": true,
+      "push": true,
+      "pull": true
+    },
+    "has_issues": true,
+    "internal_tracker": {
+      "enable_time_tracker": true,
+      "allow_only_contributors_to_track_time": true,
+      "enable_issue_dependencies": true
+    },
+    "has_wiki": false,
+    "has_pull_requests": true,
+    "has_projects": true,
+    "ignore_whitespace_conflicts": false,
+    "allow_merge_commits": true,
+    "allow_rebase": true,
+    "allow_rebase_explicit": true,
+    "allow_squash_merge": true,
+    "default_merge_style": "squash",
+    "avatar_url": "",
+    "internal": false,
+    "mirror_interval": ""
+  },
+  "sender": {"id":1,"login":"anbraten","full_name":"Anbraten","email":"anbraten@noreply.xxx","avatar_url":"https://git.xxx/user/avatar/anbraten/-1","language":"","is_admin":false,"last_login":"0001-01-01T00:00:00Z","created":"2018-03-21T10:04:48Z","restricted":false,"active":false,"prohibit_login":false,"location":"World","website":"https://xxx","description":"","visibility":"public","followers_count":1,"following_count":1,"starred_repos_count":1,"username":"anbraten"}
+}
+`

server/remote/gitea/helper.go

@@ -176,23 +176,40 @@ func buildFromPullRequest(hook *pullRequestHook) *model.Build {
 	return build
 }
 
-// helper function that extracts the Repository data from a Gitea push hook
-func repoFromPush(hook *pushHook) *model.Repo {
-	return &model.Repo{
-		Name:     hook.Repo.Name,
-		Owner:    hook.Repo.Owner.Username,
-		FullName: hook.Repo.FullName,
-		Link:     hook.Repo.URL,
+func buildFromRelease(hook *releaseHook) *model.Build {
+	avatar := expandAvatar(
+		hook.Repo.URL,
+		fixMalformedAvatar(hook.Sender.Avatar),
+	)
+	author := hook.Sender.Login
+	if author == "" {
+		author = hook.Sender.Username
+	}
+	sender := hook.Sender.Username
+	if sender == "" {
+		sender = hook.Sender.Login
+	}
+
+	return &model.Build{
+		Event:     model.EventRelease,
+		Ref:       fmt.Sprintf("refs/tags/%s", hook.Release.TagName),
+		Link:      fmt.Sprintf("%s/src/tag/%s", hook.Repo.URL, hook.Release.TagName),
+		Branch:    fmt.Sprintf("refs/tags/%s", hook.Release.TagName),
+		Message:   fmt.Sprintf("created tag %s", hook.Release.TagName),
+		Avatar:    avatar,
+		Author:    author,
+		Sender:    sender,
+		Timestamp: time.Now().UTC().Unix(),
 	}
 }
 
 // helper function that extracts the Repository data from a Gitea pull_request hook
-func repoFromPullRequest(hook *pullRequestHook) *model.Repo {
+func repoFromHook(repo *giteaRepo) *model.Repo {
 	return &model.Repo{
-		Name:     hook.Repo.Name,
-		Owner:    hook.Repo.Owner.Username,
-		FullName: hook.Repo.FullName,
-		Link:     hook.Repo.URL,
+		Name:     repo.Name,
+		Owner:    repo.Owner.Username,
+		FullName: repo.FullName,
+		Link:     repo.URL,
 	}
 }
 
@@ -209,6 +226,12 @@ func parsePullRequest(r io.Reader) (*pullRequestHook, error) {
 	return pr, err
 }
 
+func parseRelease(r io.Reader) (*releaseHook, error) {
+	pr := new(releaseHook)
+	err := json.NewDecoder(r).Decode(pr)
+	return pr, err
+}
+
 // fixMalformedAvatar is a helper function that fixes an avatar url if malformed
 // (currently a known bug with gitea)
 func fixMalformedAvatar(url string) string {

server/remote/gitea/helper_test.go

@@ -113,7 +113,7 @@ func Test_parse(t *testing.T) {
 		g.It("Should return a Repo struct from a push hook", func() {
 			buf := bytes.NewBufferString(fixtures.HookPush)
 			hook, _ := parsePush(buf)
-			repo := repoFromPush(hook)
+			repo := repoFromHook(&hook.Repo)
 			g.Assert(repo.Name).Equal(hook.Repo.Name)
 			g.Assert(repo.Owner).Equal(hook.Repo.Owner.Username)
 			g.Assert(repo.FullName).Equal("gordon/hello-world")
@@ -150,7 +150,7 @@ func Test_parse(t *testing.T) {
 		g.It("Should return a Repo struct from a pull_request hook", func() {
 			buf := bytes.NewBufferString(fixtures.HookPullRequest)
 			hook, _ := parsePullRequest(buf)
-			repo := repoFromPullRequest(hook)
+			repo := repoFromHook(&hook.Repo)
 			g.Assert(repo.Name).Equal(hook.Repo.Name)
 			g.Assert(repo.Owner).Equal(hook.Repo.Owner.Username)
 			g.Assert(repo.FullName).Equal("gordon/hello-world")