1
0
mirror of https://github.com/woodpecker-ci/woodpecker.git synced 2024-12-06 08:16:19 +02:00
Commit Graph

62 Commits

Author SHA1 Message Date
6543
d1213afdc8
[Docs] use redocusaurus to display swagger file (#1818)
https://redocusaurus.vercel.app/

followup of  #1782

---------

Co-authored-by: Anbraten <anton@ju60.de>
2023-06-04 05:07:39 +02:00
Martin W. Kirst
14177635b6
Update swagger API specification (#1782)
# Summary

This PR drops the outdated former swagger.yaml/json and introduced
automatic API document generation from Go code.
The generated code is also used to generate documentation/markdown for
the community page,
as well as enable the Woodpecker server to serve a Swagger Web UI for
manual tinkering.

I did opt-in for gin-swagger, a middleware for the Gin framework, to
ease implementation and have a sophisticated output.
This middleware only produces Swagger v2 specs. AFAIK the newer OpenApi
3x tooling is not yet that mature,
so I guess that's fine for now.

## Implemenation notes

- former swagger.json files removed
- former // swagger godocs removed
- introduced new dependency gin-swagger, which uses godoc annotations on
top of Gin Handler functions.
- reworked Makefile to automatically generate Go code for the server
- introduce new dependency go-swagger, to generate Markdown for
documentation purposes
- add a Swagger Web UI, incl. capabilities for manual API exploration
- consider relative root paths in the implementation
- write documentation for all exposed API endpoints
- incl. API docs in the community website (auto-generated)
- provide developer documentation, for the Woodpecker authors
- no other existing logic/code was intentionally changed

---------

close #292

---------

Co-authored-by: qwerty287 <80460567+qwerty287@users.noreply.github.com>
Co-authored-by: 6543 <6543@obermui.de>
2023-06-03 21:38:36 +02:00
6543
a39e8a0f9a
Make exec run be detected as WoodpeckerCI (#1218)
and exclude docs/docs/40-cli.md from git as it will be generated by CI
2022-09-27 22:19:39 +02:00
Lauris BH
99f1b70570
Add option to launch all needed services for local development (#988)
Co-authored-by: qwerty287 <80460567+qwerty287@users.noreply.github.com>
2022-06-17 16:24:49 +02:00
6543
17999da20f
Minim golang 1.18 and drop vendor folder (#979) 2022-06-17 01:57:02 +02:00
6543
17fd76b23f
Fix helm chart release (#715)
* fix helm chart release

* make it pass
2022-01-24 11:41:39 +01:00
Anbraten
bed69f9f72
Improve dev docs (#636) 2021-12-21 10:52:10 +01:00
Anbraten
465d2c9d84
Add development docs (#610)
Add documentation on how to develop woodpecker

Co-authored-by: 6543 <6543@obermui.de>
Co-authored-by: Lukas <lukas@slucky.de>
2021-12-21 04:45:41 +01:00
Anbraten
2084ff3a62
Improve release (#400)
* improve make release

* improve release

* fix release workflow
2021-10-04 19:50:21 +02:00
Anbraten
ed6d3f3cea
Use go embed for web files and remove httptreemux (#382)
- replace togo with go embed
- replace httptreemux with gin

closes #308
2021-09-29 17:34:56 +02:00
Anbraten
188b9e6eb5
Refactor cli (#329)
- move cli files from `cli/drone` to `cli/`
- move cli main to `cmd/cli/main.go` to match agent and server
- use version from `version/version.go` to match agent and server
2021-09-21 16:36:41 +02:00
Anbraten
9267a46d5c
[Docs] Migrate docs framework to Docusaurus (#282)
- Replace mkdocs with docosaurus (improved menu structure, ...)
- Structure docs into `Usage` and `Server Setup / Administration`
- Update favicon
- Create new pipeline-syntax page with all options and links to more detailed docs if available
- Add ci to publish to `woodpecker-ci.github.io`
- Deploy docs preview to surge for review
- Update start-page

Co-authored-by: 6543 <6543@obermui.de>
2021-09-11 17:10:32 +02:00
6543
75513575be
Use go's vendoring (#284)
* store dependency's in git

* since we vendor ... rm tech-depts

* aad make target 'vendor' to update vendor folder (manual task)
2021-08-30 19:14:04 +02:00
6543
978d666eac
Update Dependencies 2021-06-28 19:33:58 +02:00
6543
bfc4aa8059
Enforce code format (#228)
* format .drone.yml & go code

* improve .editorconfig

* extend Makefile

* enforce go code format

* fix space

* update deps

* clean up
2021-06-22 12:34:35 +02:00
Laszlo Fogas
2412d78a84 Add missing requirements.txt 2019-11-13 12:23:16 +01:00
Laszlo Fogas
61a14df51b Pull in frontend 2019-11-12 14:27:39 +01:00
Laszlo Fogas
3fe710bbe4 1:n relationship for build-config 2019-06-07 10:40:16 +02:00
Laszlo Fogas
0adab2c4b2 I lost these files due to a wrong .gitignore entry 2019-04-26 13:53:56 +02:00
Laszlo Fogas
2922505fe2 CLI is pulled in for simpler(?) workflow 2019-04-06 21:32:14 +02:00
folex
764c36f736 Use user/permissions bitbucket API instead of hooks 2018-04-27 19:01:15 +03:00
Brad Rydzewski
c0354572c3 remove generated migration code from gitignore 2017-05-13 10:08:39 +02:00
Brad Rydzewski
ccb28d0d74 commit embedded templates 2017-05-12 16:06:01 +02:00
Brad Rydzewski
4a40647ca0 update build process 2017-05-08 02:01:04 +02:00
Brad Rydzewski
2f579e4b7d setup store in main() 2017-05-03 23:25:33 +02:00
Brad Rydzewski
3118c07329 add proc and file structs 2017-03-28 17:53:06 +09:00
Brad Rydzewski
4d1df2924c replace UI with single page application (#1704) 2016-07-08 15:40:29 -07:00
Brad Rydzewski
64785c8b47 update yaml for s3 upload 2016-05-26 11:08:48 -07:00
Brad Rydzewski
0fb4aeda3f bump to 0.5 in master 2016-05-02 12:21:25 -07:00
Brad Rydzewski
b5823d20ff chunk the yaml into sections 2016-04-19 18:37:53 -07:00
Brad Rydzewski
fd63d6e03d refact yaml operations to yaml package 2016-04-19 13:02:28 -07:00
Brad Rydzewski
0d04fa67e3 moving API to api package, swagger annotatoins 2016-03-30 13:15:28 -07:00
Brad Rydzewski
230abeaa8c bump docker version 2016-03-24 12:56:02 -07:00
Greg Taylor
46a9f9b985 gitgnore Jetbrains .idea dirs. 2015-11-19 23:43:02 -08:00
Brad Rydzewski
6ed5ae4827 fix issue w/ missing gogs client deps 2015-10-22 17:03:07 -07:00
Brad Rydzewski
1c437686fb temporarily allow css files since sassc isn't part of the build process 2015-09-29 18:26:46 -07:00
Brad Rydzewski
dfea14c7e5 updated vendor files and paths 2015-09-29 18:21:17 -07:00
Thomas Boerger
c2346e3275 Integrated styles task 2015-08-27 10:56:29 +02:00
Brad Rydzewski
35d05b0cce added dronerc to project 2015-08-12 00:25:19 -07:00
Brad Rydzewski
98668f1141 enable dronerc in .gitignore 2015-08-12 00:23:11 -07:00
Brad Rydzewski
f1a9058191 updating styles 2015-07-29 09:16:08 -07:00
Brad Rydzewski
081f0efa0b dumb mistake excluded toml in deb 2015-06-04 13:31:48 -07:00
Brad Rydzewski
73ed4f08d5 moved to central copy function 2015-05-17 19:25:53 -07:00
Brad Rydzewski
eedfbaf202 removed and ignore bindata file 2015-05-17 14:42:21 -07:00
Brad Rydzewski
12bbbdba75 fixed gitignore of dist folder 2015-05-17 12:18:03 -07:00
Brad Rydzewski
d66becd12c fixed some minor bugs in build 2015-05-15 14:55:26 -07:00
Brad Rydzewski
ed0719c624 fixed builder panic 2015-05-12 20:30:36 -07:00
Brad Rydzewski
091f0e9918 fixed some race conditions and cpu locking 2015-05-05 20:59:07 -07:00
Brad Rydzewski
96b49cf0fc website subscribes to build events, update pages 2015-04-25 21:27:24 -07:00
Brad Rydzewski
3b7c9738a3 ability to squash and embed static files 2015-04-25 16:16:56 -07:00