Skip to content

Add pipeline author and avatar env vars #5227

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
xoxys merged 7 commits into from
Jun 27, 2025
Merged

Add pipeline author and avatar env vars #5227

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
099cd79
Add pipeline author and avatar env vars
qwerty287 May 31, 2025
4d8a937
Merge branch 'main' into pl-avatar
qwerty287 May 31, 2025
1d1ff31
openapi
qwerty287 May 31, 2025
04fd977
add migration
qwerty287 Jun 17, 2025
e25618d
Merge branch 'main' into pl-avatar
qwerty287 Jun 17, 2025
ef64250
remove old docs
qwerty287 Jun 17, 2025
bf11dbf
Merge branch 'main' into pl-avatar
qwerty287 Jun 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions cmd/server/openapi/docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5596,6 +5596,12 @@ const docTemplate = `{
"metadata.Pipeline": {
"type": "object",
"properties": {
"author": {
"type": "string"
},
"avatar": {
"type": "string"
},
"commit": {
"$ref": "#/definitions/metadata.Commit"
},
Expand Down
6 changes: 4 additions & 2 deletions docs/docs/20-usage/50-environment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 | `john-doe@example.com` |
| `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` |
Expand All @@ -90,6 +89,8 @@ This is the reference list of all environment variables available to your pipeli
| `CI_PIPELINE_CREATED` | pipeline created UNIX timestamp | `1722617519` |
| `CI_PIPELINE_STARTED` | pipeline started UNIX timestamp | `1722617519` |
| `CI_PIPELINE_FILES` | changed files (empty if event is not `push` or `pull_request`), it is undefined if more than 500 files are touched | `[]`, `[".woodpecker.yml","README.md"]` |
| `CI_PIPELINE_AUTHOR` | pipeline author username | `octocat` |
| `CI_PIPELINE_AVATAR` | pipeline author avatar | `https://git.example.com/avatars/5dcbcadbce6f87f8abef` |
| | **Current workflow** | |
| `CI_WORKFLOW_NAME` | workflow name | `release` |
| | **Current step** | |
Expand All @@ -108,7 +109,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 | `john-doe@example.com` |
| `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` |
Expand All @@ -121,6 +121,8 @@ This is the reference list of all environment variables available to your pipeli
| `CI_PREV_PIPELINE_CREATED` | previous pipeline created UNIX timestamp | `1722610173` |
| `CI_PREV_PIPELINE_STARTED` | previous pipeline started UNIX timestamp | `1722610173` |
| `CI_PREV_PIPELINE_FINISHED` | previous pipeline finished UNIX timestamp | `1722610383` |
| `CI_PREV_PIPELINE_AUTHOR` | previous pipeline author username | `octocat` |
| `CI_PREV_PIPELINE_AVATAR` | previous pipeline author avatar | `https://git.example.com/avatars/5dcbcadbce6f87f8abef` |
| |   | |
| `CI_WORKSPACE` | Path of the workspace where source code gets cloned to | `/woodpecker/src/git.example.com/john-doe/my-repo` |
| | **System** | |
Expand Down
1 change: 1 addition & 0 deletions docs/src/pages/migrations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ To enhance the usability of Woodpecker and meet evolving security standards, occ
## `next`

- (Kubernetes) Deprecated `step` label on pod in favor of new namespaced label `woodpecker-ci.org/step`. The `step` label will be removed in a future update.
- deprecated `CI_COMMIT_AUTHOR_AVATAR` and `CI_PREV_COMMIT_AUTHOR_AVATAR` env vars in favor of `CI_PIPELINE_AVATAR` and `CI_PREV_PIPELINE_AVATAR`

## 3.0.0

Expand Down
4 changes: 4 additions & 0 deletions pipeline/frontend/metadata/environment.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,8 @@ func (m *Metadata) Environ() map[string]string {
setNonEmptyEnvVar(params, "CI_PIPELINE_DEPLOY_TASK", pipeline.DeployTask)
setNonEmptyEnvVar(params, "CI_PIPELINE_CREATED", strconv.FormatInt(pipeline.Created, 10))
setNonEmptyEnvVar(params, "CI_PIPELINE_STARTED", strconv.FormatInt(pipeline.Started, 10))
setNonEmptyEnvVar(params, "CI_PIPELINE_AUTHOR", pipeline.Author)
setNonEmptyEnvVar(params, "CI_PIPELINE_AVATAR", pipeline.Avatar)

workflow := m.Workflow
setNonEmptyEnvVar(params, "CI_WORKFLOW_NAME", workflow.Name)
Expand Down Expand Up @@ -134,6 +136,8 @@ func (m *Metadata) Environ() map[string]string {
setNonEmptyEnvVar(params, "CI_PREV_PIPELINE_CREATED", strconv.FormatInt(prevPipeline.Created, 10))
setNonEmptyEnvVar(params, "CI_PREV_PIPELINE_STARTED", strconv.FormatInt(prevPipeline.Started, 10))
setNonEmptyEnvVar(params, "CI_PREV_PIPELINE_FINISHED", strconv.FormatInt(prevPipeline.Finished, 10))
setNonEmptyEnvVar(params, "CI_PREV_PIPELINE_AUTHOR", prevPipeline.Author)
setNonEmptyEnvVar(params, "CI_PREV_PIPELINE_AVATAR", prevPipeline.Avatar)

prevCommit := prevPipeline.Commit
setNonEmptyEnvVar(params, "CI_PREV_COMMIT_SHA", prevCommit.Sha)
Expand Down
2 changes: 2 additions & 0 deletions pipeline/frontend/metadata/types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ type (
Commit Commit `json:"commit,omitempty"`
Parent int64 `json:"parent,omitempty"`
Cron string `json:"cron,omitempty"`
Author string `json:"author,omitempty"`
Comment thread
qwerty287 marked this conversation as resolved.
Avatar string `json:"avatar,omitempty"`
}

// Commit defines runtime metadata for a commit.
Expand Down
4 changes: 3 additions & 1 deletion server/pipeline/stepbuilder/metadata.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,8 @@ func metadataPipelineFromModelPipeline(pipeline *model.Pipeline, includeParent b
PullRequestLabels: pipeline.PullRequestLabels,
IsPrerelease: pipeline.IsPrerelease,
},
Cron: cron,
Cron: cron,
Author: pipeline.Author,
Avatar: pipeline.Avatar,
}
}