Rework pipeline messages

cli/exec/flags.go

@@ -270,11 +270,6 @@ var flags = []cli.Flag{
 		Name:    "commit-author-name",
 		Usage:   "Set the metadata environment variable \"CI_COMMIT_AUTHOR\".",
 	},
-	&cli.StringFlag{
-		Sources: cli.EnvVars("CI_COMMIT_AUTHOR_AVATAR"),
-		Name:    "commit-author-avatar",
-		Usage:   "Set the metadata environment variable \"CI_COMMIT_AUTHOR_AVATAR\".",
-	},
 	&cli.StringFlag{
 		Sources: cli.EnvVars("CI_COMMIT_AUTHOR_EMAIL"),
 		Name:    "commit-author-email",
@@ -365,11 +360,6 @@ var flags = []cli.Flag{
 		Name:    "prev-commit-author-name",
 		Usage:   "Set the metadata environment variable \"CI_PREV_COMMIT_AUTHOR\".",
 	},
-	&cli.StringFlag{
-		Sources: cli.EnvVars("CI_PREV_COMMIT_AUTHOR_AVATAR"),
-		Name:    "prev-commit-author-avatar",
-		Usage:   "Set the metadata environment variable \"CI_PREV_COMMIT_AUTHOR_AVATAR\".",
-	},
 	&cli.StringFlag{
 		Sources: cli.EnvVars("CI_PREV_COMMIT_AUTHOR_EMAIL"),
 		Name:    "prev-commit-author-email",

cli/exec/metadata.go

@@ -106,7 +106,6 @@ func metadataFromContext(_ context.Context, c *cli.Command, axis matrix.Axis, w
 	metadataFileAndOverrideOrDefault(c, "commit-message", func(s string) { m.Curr.Commit.Message = s }, c.String)
 	metadataFileAndOverrideOrDefault(c, "commit-author-name", func(s string) { m.Curr.Commit.Author.Name = s }, c.String)
 	metadataFileAndOverrideOrDefault(c, "commit-author-email", func(s string) { m.Curr.Commit.Author.Email = s }, c.String)
-	metadataFileAndOverrideOrDefault(c, "commit-author-avatar", func(s string) { m.Curr.Commit.Author.Avatar = s }, c.String)
 
 	metadataFileAndOverrideOrDefault(c, "commit-pull-labels", func(sl []string) { m.Curr.Commit.PullRequestLabels = sl }, c.StringSlice)
 	metadataFileAndOverrideOrDefault(c, "commit-release-is-pre", func(b bool) { m.Curr.Commit.IsPrerelease = b }, c.Bool)
@@ -128,7 +127,6 @@ func metadataFromContext(_ context.Context, c *cli.Command, axis matrix.Axis, w
 	metadataFileAndOverrideOrDefault(c, "prev-commit-message", func(s string) { m.Prev.Commit.Message = s }, c.String)
 	metadataFileAndOverrideOrDefault(c, "prev-commit-author-name", func(s string) { m.Prev.Commit.Author.Name = s }, c.String)
 	metadataFileAndOverrideOrDefault(c, "prev-commit-author-email", func(s string) { m.Prev.Commit.Author.Email = s }, c.String)
-	metadataFileAndOverrideOrDefault(c, "prev-commit-author-avatar", func(s string) { m.Prev.Commit.Author.Avatar = s }, c.String)
 
 	// Workflow
 	metadataFileAndOverrideOrDefault(c, "workflow-name", func(s string) { m.Workflow.Name = s }, c.String)

cli/pipeline/pipeline.go

@@ -89,6 +89,10 @@ func pipelineOutput(c *cli.Command, pipelines []*woodpecker.Pipeline, fd ...io.W
 		if !noHeader {
 			table.WriteHeader(cols)
 		}
+		table.AddFieldFn("message", func(obj any) string {
+			pl, _ := obj.(*woodpecker.Pipeline)
+			return pl.Commit.Message
+		})
 		for _, resource := range pipelines {
 			if err := table.Write(cols, resource); err != nil {
 				return err

cli/pipeline/pipeline_test.go

@@ -49,12 +49,14 @@ func TestPipelineOutput(t *testing.T) {
 
 	pipelines := []*woodpecker.Pipeline{
 		{
-			Number:  1,
-			Status:  "success",
-			Event:   "push",
-			Branch:  "main",
-			Message: "message\nmultiline",
-			Author:  "John Doe\n",
+			Number: 1,
+			Status: "success",
+			Event:  "push",
+			Branch: "main",
+			Commit: &woodpecker.Commit{
+				Message: "message\nmultiline",
+			},
+			Author: "John Doe\n",
 		},
 	}
 

cmd/server/openapi/docs.go

@@ -4705,18 +4705,18 @@ const docTemplate = `{
                 "author_avatar": {
                     "type": "string"
                 },
-                "author_email": {
-                    "type": "string"
-                },
                 "branch": {
                     "type": "string"
                 },
                 "commit": {
-                    "type": "string"
+                    "$ref": "#/definitions/model.Commit"
                 },
                 "created": {
                     "type": "integer"
                 },
+                "deployment": {
+                    "$ref": "#/definitions/model.Deployment"
+                },
                 "event": {
                     "type": "string"
                 },
@@ -4726,18 +4726,21 @@ const docTemplate = `{
                 "id": {
                     "type": "integer"
                 },
-                "message": {
-                    "type": "string"
-                },
                 "number": {
                     "type": "integer"
                 },
+                "pull_request": {
+                    "$ref": "#/definitions/PullRequest"
+                },
                 "ref": {
                     "type": "string"
                 },
                 "refspec": {
                     "type": "string"
                 },
+                "release": {
+                    "type": "string"
+                },
                 "repo_id": {
                     "type": "integer"
                 },
@@ -4746,9 +4749,6 @@ const docTemplate = `{
                 },
                 "status": {
                     "type": "string"
-                },
-                "title": {
-                    "type": "string"
                 }
             }
         },
@@ -4883,9 +4883,6 @@ const docTemplate = `{
                 "author_avatar": {
                     "type": "string"
                 },
-                "author_email": {
-                    "type": "string"
-                },
                 "branch": {
                     "type": "string"
                 },
@@ -4896,16 +4893,16 @@ const docTemplate = `{
                     }
                 },
                 "commit": {
-                    "type": "string"
+                    "$ref": "#/definitions/model.Commit"
                 },
                 "created": {
                     "type": "integer"
                 },
-                "deploy_task": {
+                "cron": {
                     "type": "string"
                 },
-                "deploy_to": {
-                    "type": "string"
+                "deployment": {
+                    "$ref": "#/definitions/model.Deployment"
                 },
                 "errors": {
                     "type": "array",
@@ -4922,58 +4919,42 @@ const docTemplate = `{
                 "forge_url": {
                     "type": "string"
                 },
-                "from_fork": {
-                    "type": "boolean"
-                },
                 "id": {
                     "type": "integer"
                 },
                 "is_prerelease": {
                     "type": "boolean"
                 },
-                "message": {
-                    "type": "string"
-                },
                 "number": {
                     "type": "integer"
                 },
                 "parent": {
                     "type": "integer"
                 },
-                "pr_labels": {
-                    "type": "array",
-                    "items": {
-                        "type": "string"
-                    }
+                "pull_request": {
+                    "$ref": "#/definitions/PullRequest"
                 },
                 "ref": {
                     "type": "string"
                 },
                 "refspec": {
                     "type": "string"
                 },
+                "release": {
+                    "type": "string"
+                },
                 "reviewed": {
                     "type": "integer"
                 },
                 "reviewed_by": {
                     "type": "string"
                 },
-                "sender": {
-                    "description": "uses reported user for webhooks and name of cron for cron pipelines",
-                    "type": "string"
-                },
                 "started": {
                     "type": "integer"
                 },
                 "status": {
                     "$ref": "#/definitions/StatusValue"
                 },
-                "timestamp": {
-                    "type": "integer"
-                },
-                "title": {
-                    "type": "string"
-                },
                 "updated": {
                     "type": "integer"
                 },
@@ -5008,9 +4989,18 @@ const docTemplate = `{
         "PullRequest": {
             "type": "object",
             "properties": {
+                "from_fork": {
+                    "type": "boolean"
+                },
                 "index": {
                     "type": "string"
                 },
+                "labels": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                },
                 "title": {
                     "type": "string"
                 }
@@ -5399,9 +5389,6 @@ const docTemplate = `{
         "metadata.Author": {
             "type": "object",
             "properties": {
-                "avatar": {
-                    "type": "string"
-                },
                 "email": {
                     "type": "string"
                 },
@@ -5515,6 +5502,9 @@ const docTemplate = `{
                 "parent": {
                     "type": "integer"
                 },
+                "release": {
+                    "type": "string"
+                },
                 "started": {
                     "type": "integer"
                 },
@@ -5647,6 +5637,48 @@ const docTemplate = `{
                 "RequireApprovalAllEvents"
             ]
         },
+        "model.Commit": {
+            "type": "object",
+            "properties": {
+                "author": {
+                    "$ref": "#/definitions/model.CommitAuthor"
+                },
+                "forge_url": {
+                    "type": "string"
+                },
+                "message": {
+                    "type": "string"
+                },
+                "sha": {
+                    "type": "string"
+                }
+            }
+        },
+        "model.CommitAuthor": {
+            "type": "object",
+            "properties": {
+                "author": {
+                    "type": "string"
+                },
+                "email": {
+                    "type": "string"
+                }
+            }
+        },
+        "model.Deployment": {
+            "type": "object",
+            "properties": {
+                "description": {
+                    "type": "string"
+                },
+                "target": {
+                    "type": "string"
+                },
+                "task": {
+                    "type": "string"
+                }
+            }
+        },
         "model.ForgeType": {
             "type": "string",
             "enum": [

docs/docs/20-usage/50-environment.md

@@ -77,7 +77,6 @@ This is the reference list of all environment variables available to your pipeli
 | `CI_COMMIT_MESSAGE`              | commit message                                                                                                     | `Initial commit`                                                                           |
 | `CI_COMMIT_AUTHOR`               | commit author username                                                                                             | `john-doe`                                                                                 |
 | `CI_COMMIT_AUTHOR_EMAIL`         | commit author email address                                                                                        | `[email protected]`                                                                     |
-| `CI_COMMIT_AUTHOR_AVATAR`        | commit author avatar                                                                                               | `https://git.example.com/avatars/5dcbcadbce6f87f8abef`                                     |
 | `CI_COMMIT_PRERELEASE`           | release is a pre-release (empty if event is not `release`)                                                         | `false`                                                                                    |
 |                                  | **Current pipeline**                                                                                               |                                                                                            |
 | `CI_PIPELINE_NUMBER`             | pipeline number                                                                                                    | `8`                                                                                        |
@@ -108,7 +107,6 @@ This is the reference list of all environment variables available to your pipeli
 | `CI_PREV_COMMIT_MESSAGE`         | previous commit message                                                                                            | `test`                                                                                     |
 | `CI_PREV_COMMIT_AUTHOR`          | previous commit author username                                                                                    | `john-doe`                                                                                 |
 | `CI_PREV_COMMIT_AUTHOR_EMAIL`    | previous commit author email address                                                                               | `[email protected]`                                                                     |
-| `CI_PREV_COMMIT_AUTHOR_AVATAR`   | previous commit author avatar                                                                                      | `https://git.example.com/avatars/12`                                                       |
 |                                  | **Previous pipeline**                                                                                              |                                                                                            |
 | `CI_PREV_PIPELINE_NUMBER`        | previous pipeline number                                                                                           | `7`                                                                                        |
 | `CI_PREV_PIPELINE_PARENT`        | previous pipeline number of parent pipeline                                                                        | `0`                                                                                        |

docs/src/pages/migrations.md

@@ -1,10 +1,16 @@
+<!-- markdownlint-disable no-duplicate-heading -->
+
 # Migrations
 
 To enhance the usability of Woodpecker and meet evolving security standards, occasional migrations are necessary. While we aim to minimize these changes, some are unavoidable. If you experience significant issues during a migration to a new version, please let us know so maintainers can reassess the updates.
 
 ## `next`
 
-- No changes
+### User-facing changes
+
+#### API changes
+
+- Changed the pipeline model to have different objects for different event metadata (e.g. pull request title)
 
 ## 3.0.0
 
@@ -65,6 +71,7 @@ The following built-in environment variables have been removed/replaced:
 - `CI_PIPELINE_FINISHED` as it was empty during execution
 - `CI_PIPELINE_STATUS` due to always being set to `success`
 - `CI_STEP_STATUS` due to always being set to `success`
+- `CI_COMMIT_AUTHOR_AVATAR` and `CI_PREV_COMMIT_AUTHOR_AVATAR` as commit authors don't have an avatar
 - `WOODPECKER_WEBHOOK_HOST` in favor of `WOODPECKER_EXPERT_WEBHOOK_HOST`
 
 Environment variables which are empty after workflow parsing are not being injected into the build but filtered out beforehand ([#4193](https://github.com/woodpecker-ci/woodpecker/pull/4193))
@@ -83,6 +90,38 @@ The following syntax deprecations will now result in an error:
 - `platform:` ([#3916](https://github.com/woodpecker-ci/woodpecker/pull/3916))
 - `branches:` ([#3916](https://github.com/woodpecker-ci/woodpecker/pull/3916))
 
+#### Workflow syntax changes
+
+- Grouping of steps via `steps.[name].group` should now be done using `steps.[name].depends_on`
+- The `includes` and `excludes` event filter options have been removed
+- Previously, env vars have been automatically sanitized to uppercase.
+  As this has been confusing, the type-case of the secret definition is now respected ([#3375](https://github.com/woodpecker-ci/woodpecker/pull/3375)).
+- `secrets` have been entirely removed in favor of `environment` combined with the `from_secret` syntax.
+  As `secrets` are just normal env vars which are masked, the goal was to allow them to be declared next to normal env vars and at the same time reduce the keyword syntax count.
+  Additionally, the `from_secret` syntax gives more flexibility in naming.
+  Whereas beforehand `secrets` where always named after their initial secret name, the `from_secret` reference can now be different.
+  Last, one can inject multiple different env vars from the same secret reference.
+
+  2.x:
+
+  ```yaml
+  secrets: [my_token]
+  ```
+
+  3.x:
+
+  ```yaml
+  environment:
+    MY_TOKEN:
+      from_secret: my_token
+  ```
+
+- The `environment` filter option has been removed in favor of `when.evaluate`
+
+#### API changes
+
+- Removed deprecated `registry/` endpoint. Use `registries`, `/authorize/token`
+
 #### CLI changes
 
 The following restructuring was done to achieve a more consistent grouping: