github/woodpecker
1
0
Fork 0
mirror of https://github.com/woodpecker-ci/woodpecker.git synced 2025-08-13 18:15:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add docs-dependencies target to makefile (#4719)

Browse Source
This commit is contained in:
Robert Kaussow 2025-01-13 13:11:32 +01:00 committed by GitHub
parent e51df2db5e
commit 0c683110f5
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
8 changed files with 17 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.woodpecker/docs.yaml
View File

@ -50,7 +50,7 @@ steps:
build-cli: build-cli:
image: *golang_image image: *golang_image
commands: commands:
- make docs - make generate-docs
when: when:
- path: *when_path - path: *when_path
event: [tag, pull_request, push] event: [tag, pull_request, push]

12
Makefile
View File

@ -337,9 +337,17 @@ spellcheck:
pnpx cspell lint --no-progress stdin pnpx cspell lint --no-progress stdin
##@ Docs ##@ Docs
.PHONY: docs .PHONY: docs-dependencies
docs: ## Generate docs (currently only for the cli) docs-dependencies: ## Install docs dependencies
(cd docs/; pnpm install --frozen-lockfile)
.PHONY: generate-docs
generate-docs: ## Generate docs (currently only for the cli)
CGO_ENABLED=0 go generate cmd/cli/app.go CGO_ENABLED=0 go generate cmd/cli/app.go
CGO_ENABLED=0 go generate cmd/server/openapi.go CGO_ENABLED=0 go generate cmd/server/openapi.go
.PHONY: build-docs
build-docs: generate-docs docs-dependencies ## Build the docs
(cd docs/; pnpm build)
endif endif

2
docs/docs/92-development/09-openapi.md
View File

@ -55,5 +55,5 @@ make generate-openapi
``` ```
```bash title="update the Markdown in the ./docs folder" ```bash title="update the Markdown in the ./docs folder"
make docs make generate-docs
``` ```

2
docs/package.json
View File

@ -3,7 +3,7 @@
"version": "0.0.0", "version": "0.0.0",
"private": true, "private": true,
"scripts": { "scripts": {
"start": "cd ../ && make docs && cd docs && docusaurus start", "start": "cd ../ && make generate-docs && cd docs && docusaurus start",
"build": "pnpm build:woodpecker-plugins && docusaurus build", "build": "pnpm build:woodpecker-plugins && docusaurus build",
"build:woodpecker-plugins": "cd plugins/woodpecker-plugins && pnpm i && pnpm build", "build:woodpecker-plugins": "cd plugins/woodpecker-plugins && pnpm i && pnpm build",
"swizzle": "docusaurus swizzle", "swizzle": "docusaurus swizzle",

2
docs/versioned_docs/version-1.0/92-development/08-swagger.md
View File

@ -61,7 +61,7 @@ make generate-swagger
##### update the Markdown in the ./docs folder ##### update the Markdown in the ./docs folder
```shell ```shell
make docs make generate-docs
``` ```
##### auto-format swagger related godoc ##### auto-format swagger related godoc

2
docs/versioned_docs/version-2.6/92-development/08-swagger.md
View File

@ -55,7 +55,7 @@ make generate-swagger
``` ```
```bash title="update the Markdown in the ./docs folder" ```bash title="update the Markdown in the ./docs folder"
make docs make generate-docs
``` ```
```bash title="auto-format swagger related godoc" ```bash title="auto-format swagger related godoc"

2
docs/versioned_docs/version-2.7/92-development/09-swagger.md
View File

@ -55,7 +55,7 @@ make generate-swagger
``` ```
```bash title="update the Markdown in the ./docs folder" ```bash title="update the Markdown in the ./docs folder"
make docs make generate-docs
``` ```
```bash title="auto-format swagger related godoc" ```bash title="auto-format swagger related godoc"

2
docs/versioned_docs/version-2.8/92-development/09-swagger.md
View File

@ -55,7 +55,7 @@ make generate-swagger
``` ```
```bash title="update the Markdown in the ./docs folder" ```bash title="update the Markdown in the ./docs folder"
make docs make generate-docs
``` ```
```bash title="auto-format swagger related godoc" ```bash title="auto-format swagger related godoc"