mirrors/woodpecker
1
0
Fork 0
mirror of https://github.com/woodpecker-ci/woodpecker.git synced 2024-05-18 06:02:38 +00:00
Code Issues Projects Releases Wiki Activity
woodpecker/docs
History
velsinki dda4998261
Change healtcheck port into address format, redo #1197 (#1423) 
As discussed in the comments in PR #1197. Also add documenation
accordingly.

One thing I'm not sure about is the simple check in health.go if the
address is usable in the GET request or not. From reading
https://pkg.go.dev/net#Dial it seems that the only non-standard address
format that would work in the `net` package but not in a GET url would
likely only be `:port`, as the others listed here are actually also
valid urls:

`For TCP, UDP and IP networks, if the host is empty or a literal
unspecified IP address, as in ":80", "0.0.0.0:80" or "[::]:80" for TCP
and UDP, "", "0.0.0.0" or "::" for IP, the local system is assumed.`

One additional thing I noticed is that while `WOODPECKER_SERVER_ADDR`
and `WOODPECKER_SERVER_ADDR` use the default value format of `:PORT`,
`WOODPECKER_SERVER` actually uses `localhost:9000`. I guess it makes a
bit of sense, considering the server might not be local to the agent,
but it looks a bit inconsistent this way. I don't think it would hurt to
make the `WOODPECKER_HEALTHCHECK_ADDR` in this format too, but then it's
different from the server flags again... :-)
2022-11-19 13:06:51 +02:00
..
docs Change healtcheck port into address format, redo #1197 (#1423) 2022-11-19 13:06:51 +02:00
plugins/woodpecker-plugins Spelling (#1405) 2022-11-09 08:12:17 +01:00
src Fix broken link in FAQ (#1413) 2022-11-10 18:36:41 +01:00
static Improve plugins index (#1200) 2022-09-25 19:04:47 +02:00
versioned_docs/version-0.15 Spelling (#1405) 2022-11-09 08:12:17 +01:00
versioned_sidebars Use versioned docs (#1145) 2022-09-01 01:52:52 +02:00
.gitignore [Docs] Migrate docs framework to Docusaurus (#282) 2021-09-11 17:10:32 +02:00
.prettierrc.js Improve docs (#450) 2021-10-16 21:27:51 +02:00
babel.config.js [Docs] Migrate docs framework to Docusaurus (#282) 2021-09-11 17:10:32 +02:00
docusaurus.config.js Update Mastodon link (#1364) 2022-10-29 14:07:35 +03:00
LICENSE Optimize license files (#355) 2021-09-25 15:15:54 +02:00
package.json Update all dependencies (#1291) 2022-10-19 10:15:58 +02:00
pnpm-lock.yaml Update all dependencies (#1291) 2022-10-19 10:15:58 +02:00
README.md Replace yarn with pnpm (#1240) 2022-10-08 16:15:07 +02:00
sidebars.js [Docs] Migrate docs framework to Docusaurus (#282) 2021-09-11 17:10:32 +02:00
tsconfig.json Improve docs (#450) 2021-10-16 21:27:51 +02:00
versions.json Use versioned docs (#1145) 2022-09-01 01:52:52 +02:00

README.md

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ pnpm install

Local Development

$ pnpm start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ pnpm build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Deployment happen via CI to woodpecker-ci.org.

To manually build the website and push it exec:

GIT_USER=woodpecker-bot USE_SSH=true DEPLOYMENT_BRANCH=master pnpm deploy