Skip to content

Commit

Permalink
Create 2.5 docs (#3732)
Browse files Browse the repository at this point in the history
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: qwerty287 <[email protected]>
Co-authored-by: qwerty287 <[email protected]>
  • Loading branch information
4 people authored Jun 1, 2024
1 parent 9c7e925 commit 13c6150
Show file tree
Hide file tree
Showing 86 changed files with 11,317 additions and 958 deletions.
90 changes: 90 additions & 0 deletions docs/blog/2024-05-27-release-v2.5.0/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
---
title: Here is Woodpecker 2.5.0
description: Introducing Woodpecker 2.5.0
slug: release-v250
authors:
- name: Anbraten
title: Maintainer of Woodpecker
url: https://github.com/anbraten
image_url: https://github.com/anbraten.png
tags: [release, minor]
hide_table_of_contents: false
---

Here is the next minor release 2.5.0 of Woodpecker 🪶 ☀️.

<!--truncate-->

As always thanks to all contributors who helped to make this release possible. It includes quite a few enhancements
most users will benefit from while they are probably not that visible at first sight for most. The release also includes some preparations for new features to come in the next versions. Anyway, let's dive into some of the highlights of this release:

## Improve the way entrypoints work

The implementation wasn't perfect yet so we improved the way entrypoints work:

If you define [`commands`](/docs/usage/workflow-syntax#commands), the default entrypoint will be `["/bin/sh", "-c", "echo $CI_SCRIPT | base64 -d | /bin/sh -e"]`.

If you define your own entrypoint, you can completely overwrite the default entrypoint. If you define `entrypoint: ["/bin/my-script", ""]` for example you can run your own binary / script. In this case the commands section will ignord, however you can still access it in your own script by using the base64 encoded string of the `CI_SCRIPT` environment variable.

[#3269](https://github.com/woodpecker-ci/woodpecker/pull/3269)

## Cli output formats

The cli output has been improved. The first command (mainly pipeline info, ls, create) support a `--output` flag now which allows you to change the output format. There is a new `table` format (the new default) which will look like the following and can be further customized:

```bash
# use default table output
❯ woodpecker-cli pipeline ls --limit 2 2
NUMBER STATUS EVENT BRANCH COMMIT AUTHOR
43 error manual main 473761d8b26b20f7c206408563d54cf998410329 woodpecker
42 success push main 473761d8b26b20f7c206408563d54cf998410329 woodpecker

# customize table output and disable header
❯ woodpecker-cli pipeline ls --limit 2 --output table=number,status,event --no-header 2
43 error manual
42 success push
```

In addition especially useful for programmtic usage there is a `go-template` output format which will output the data using the provided go template like this:

```bash
########
# go crazy and use a template layout
❯ woodpecker-cli pipeline ls --limit 2 --output go-template='{{range .}}{{printf "\x1b[33mPipeline #%d\x1b[0m\nStatus: %s\nEvent:%s\nCommit:%s\n\n" .Number .Status .Event .Commit}}{{end}}' 2
Pipeline #43
Status: error
Event:manual
Commit:473761d8b26b20f7c206408563d54cf998410329

Pipeline #42
Status: success
Event:push
Commit:473761d8b26b20f7c206408563d54cf998410329
```

[#3660](https://github.com/woodpecker-ci/woodpecker/pull/3660)

## Deleting logs or complete pipelines

If you accidentially exposed some secret to the public in your logs or you simply want to cleanup some logs you can now delete logs or complete pipelines using the api and the cli.

[#3451](https://github.com/woodpecker-ci/woodpecker/pull/3451)
[#3506](https://github.com/woodpecker-ci/woodpecker/pull/3506)
[#3458](https://github.com/woodpecker-ci/woodpecker/pull/3458)

## Support for Github deploy tasks

Woodpecker now supports Github deploy tasks. This allows you to pass the deploy task set in Github to your Woodpecker pipeline.

[#3512](https://github.com/woodpecker-ci/woodpecker/pull/3512)

## Deprecations

To keep things clean and simple we deprecated some pipeline options, server settings and features which will
be removed in the next major release:

- Deprecated `environment` filter, use `when.evaluate`
- Use `WOODPECKER_EXPERT_FORGE_OAUTH_HOST` instead of `WOODPECKER_DEV_GITEA_OAUTH_URL` or `WOODPECKER_DEV_OAUTH_HOST`
- Deprecated `WOODPECKER_WEBHOOK_HOST` in favor of `WOODPECKER_EXPERT_WEBHOOK_HOST`

For a full list of deprecations that will be dropped in the `next` major release `3.0.0` (no eta yet), please check the [migrations](/docs/migrations#next) section.
54 changes: 31 additions & 23 deletions docs/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,30 +35,32 @@ const config: Config = {
position: 'left',
label: 'Plugins',
},
{ to: 'blog', label: 'Blog', position: 'left' },
{
to: '/docs/next/migrations', // Always point to newest migration guide
activeBaseRegex: 'docs/(next/)?migrations',
position: 'left',
label: 'Migrations',
},
{
to: '/faq',
position: 'left',
label: 'FAQ',
},
{
to: '/docs/next/awesome', // Always point to newest awesome list
activeBaseRegex: 'docs/(next/)?awesome',
position: 'left',
label: 'Awesome',
},
{
to: '/api',
label: 'More Resources',
position: 'left',
label: 'API',
items: [
{
to: '/docs/next/migrations', // Always point to newest migration guide
activeBaseRegex: 'docs/(next/)?migrations',
label: 'Migrations',
},
{
to: '/docs/next/awesome', // Always point to newest awesome list
activeBaseRegex: 'docs/(next/)?awesome',
label: 'Awesome',
},
{
to: '/faq',
label: 'FAQ',
},
{
to: '/api',
label: 'API',
},
{ to: 'cookbook', label: 'Cookbook' },
],
},
{ to: 'blog', label: 'Blog', position: 'left' },
{ to: 'cookbook', label: 'Cookbook', position: 'left' },
{
type: 'docsVersionDropdown',
position: 'right',
Expand Down Expand Up @@ -207,7 +209,7 @@ const config: Config = {
webSocketURL: 'auto://0.0.0.0:0/ws',
},
},
};
} as any;
},
}),
[
Expand Down Expand Up @@ -243,14 +245,20 @@ const config: Config = {
sidebarPath: require.resolve('./sidebars.js'),
editUrl: 'https://github.com/woodpecker-ci/woodpecker/edit/main/docs/',
includeCurrentVersion: true,
lastVersion: '2.4',
lastVersion: '2.5',
onlyIncludeVersions:
process.env.NODE_ENV === 'development' ? ['current', '2.5'] : ['current', '2.5', '2.4', '2.3', '1.0'],
versions: {
current: {
label: 'Next',
banner: 'unreleased',
},
'2.5': {
label: '2.5.x',
},
'2.4': {
label: '2.4.x',
banner: 'unmaintained',
},
'2.3': {
label: '2.3.x',
Expand Down
2 changes: 1 addition & 1 deletion docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
"esbuild-loader": "^4.1.0",
"file-loader": "^6.2.0",
"prism-react-renderer": "^2.3.1",
"react": "^18.2.0",
"react": "^18.3.1",
"react-dom": "^18.2.0",
"redocusaurus": "^2.0.2",
"url-loader": "^4.1.1"
Expand Down
25 changes: 12 additions & 13 deletions docs/plugins/woodpecker-plugins/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,25 +10,24 @@
"style": "mkdir -p dist/theme/ && cp src/theme/style.css dist/theme/style.css"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "^3.0.0",
"@docusaurus/theme-classic": "^3.0.0",
"@docusaurus/types": "^3.0.0",
"@tsconfig/docusaurus": "^2.0.0",
"@types/marked": "^6.0.0",
"@types/node": "^20.11.30",
"axios": "^1.6.8",
"concurrently": "^8.0.0",
"isomorphic-dompurify": "^2.5.0",
"marked": "^12.0.1",
"tslib": "^2.6.1",
"typescript": "^5.4.3"
"@docusaurus/module-type-aliases": "^3.3.2",
"@docusaurus/theme-classic": "^3.3.2",
"@docusaurus/types": "^3.3.2",
"@tsconfig/docusaurus": "^2.0.3",
"@types/node": "^20.12.13",
"axios": "^1.7.2",
"concurrently": "^8.2.2",
"isomorphic-dompurify": "^2.11.0",
"marked": "^12.0.2",
"tslib": "^2.6.2",
"typescript": "^5.4.5"
},
"peerDependencies": {
"react": "^17.0.2 || ^18.0.0",
"react-dom": "^17.0.2 || ^18.0.0"
},
"dependencies": {
"fuse.js": "^7.0.0",
"yaml": "^2.4.1"
"yaml": "^2.4.2"
}
}
Loading

0 comments on commit 13c6150

Please sign in to comment.