fix and lint swagger file #3007

6543 · 2023-12-23T22:47:06Z

No description provided.

cmd/server/woodpecker_docs_gen.go

woodpecker-bot · 2023-12-24T00:45:57Z

Deployment of preview was successful: https://woodpecker-ci-woodpecker-pr-3007.surge.sh

codecov · 2023-12-24T00:57:02Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (04d1f9f) 35.76% compared to head (212b621) 35.76%.
Report is 1 commits behind head on main.

❗ Current head 212b621 differs from pull request most recent head 53a473e. Consider uploading reports for the commit 53a473e to get more accurate results

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #3007   +/-   ##
=======================================
  Coverage   35.76%   35.76%           
=======================================
  Files         221      221           
  Lines       14170    14170           
=======================================
  Hits         5068     5068           
  Misses       8724     8724           
  Partials      378      378

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

qwerty287 · 2023-12-24T07:57:07Z

Why do we need this? Shouldn't there be the check_swagger step which makes sure it is up-to-date and thus also should make sure that it's a valid openapi file?

6543 · 2023-12-24T09:53:47Z

Well yes but we lib we use to gen dont detect errors as you can see.

6543 · 2023-12-24T10:24:53Z

woodpecker/.woodpecker/test.yml

Lines 59 to 66 in 9d9bcbf

    
           check_swagger: 
        
             image: *golang_image 
        
             group: test 
        
             commands: 
        
               - 'make generate-swagger' 
        
               - 'DIFF=$(git diff | head)' 
        
               - '[ -n "$DIFF" ] && { echo "swagger not up to date, exec `make generate-swagger` and commit"; exit 1; } || true' 
        
             when: *when

hmm looks like i can move the check a bit :)

6543 · 2023-12-24T10:28:25Z

@qwerty287 updated :)

qwerty287 · 2023-12-24T12:05:21Z

Did you use swag fmt to format the swagger docs? Could be a good idea too

6543 · 2023-12-24T12:33:39Z

Why it's just generated json?

You should not manually edit it anyway.

qwerty287 · 2023-12-24T13:09:20Z

No, swag fmt formats the comments in go code.

6543 · 2023-12-24T14:17:53Z

Well we additionally could do that, but it did not detect the errors in the first place so it can not be used for linting 😆

PS: can you push the codeformat onto this branch?

qwerty287 · 2023-12-24T14:34:35Z

@6543 see 6543-forks#4

Reformat swagger comments

6543 · 2023-12-24T14:46:47Z

@qwerty287 this format should go into precommit ... do you know how to do that?

qwerty287 · 2023-12-24T14:49:20Z

No… I think you need to write a hook for it somehow, but I don't know how to do it

## [2.1.0](https://github.com/woodpecker-ci/woodpecker/releases/tag/2.1.0) - 2023-12-26 ### ✨ Features - Add pull request closed event [[#2684](#2684)] - Add depends_on support for steps [[#2771](#2771)] - gitlab: support nested repos [[#2981](#2981)] - Support go plugins for forges and agent backends [[#2751](#2751)] ### 📈 Enhancement - Show default branch on top [[#3019](#3019)] - Support more addon types [[#2984](#2984)] - Hide PR tab if PRs are disabled [[#3004](#3004)] - Switch to ULID [[#2986](#2986)] - Ignore pipelines without config [[#2949](#2949)] - Link labels to input and select [[#2974](#2974)] - Register Agent with hostname [[#2936](#2936)] - Update slogan & logo [[#2962](#2962)] - Improve error handling when activating a repository [[#2965](#2965)] - Add check for storage where repo/org name is empty [[#2968](#2968)] - Update pipeline icons [[#2783](#2783)] - Kubernetes refactor [[#2794](#2794)] - Export changed files via builtin environment variables [[#2935](#2935)] - Show secrets from org and global level [[#2873](#2873)] - Only update pipelineStatus in one place [[#2952](#2952)] - Rename `engine` to `backend` [[#2950](#2950)] - Add linting for `log.Fatal()` [[#2946](#2946)] - Remove separate root path config [[#2943](#2943)] - init CI_COMMIT_TAG if commit ref is a tag [[#2934](#2934)] - Update go module path for major version 2 [[#2905](#2905)] - Unify date/time dependencies [[#2891](#2891)] - Add linting for `any` [[#2893](#2893)] - Fix vite deprecations [[#2885](#2885)] - Migrate to Xormigrate [[#2711](#2711)] - Simple security context options (Kubernetes) [[#2550](#2550)] - Changes PullRequest Index to ForgeRemoteID type [[#2823](#2823)] ### 🐛 Bug Fixes - Hide queue visualization if nothing to show [[#3003](#3003)] - fix and lint swagger file [[#3007](#3007)] - Fix IPv6 host aliases for kubernetes [[#2992](#2992)] - Fix cli lint throwing error on warnings [[#2995](#2995)] - Fix static file caching [[#2975](#2975)] - Gitea driver: ignore GetOrg error if we get a valid user. [[#2967](#2967)] - feat(k8s): Add a port name to service definition [[#2933](#2933)] - Fix error container overflow [[#2957](#2957)] - ignore some errors on repairAllRepos [[#2792](#2792)] - Allow to restart pipelines that has warnings [[#2939](#2939)] - Fix skipped pipelines model [[#2923](#2923)] - fix: Add `backend_options` to service linter entry [[#2930](#2930)] - Fix flags added multiple times [[#2914](#2914)] - Fix schema validation with array syntax for clone and services [[#2920](#2920)] - Fix prometheus docs [[#2919](#2919)] - Fix podman agent container in v2 [[#2897](#2897)] - Fix bitbucket org fetching [[#2874](#2874)] - Only deploy docs on `main` [[#2892](#2892)] - Fix pipeline-related environment [[#2876](#2876)] - Fix version check partially [[#2871](#2871)] - Fix unregistering agents when using agent tokens [[#2870](#2870)] ### 📚 Documentation - [Awesome Woodpecker] added yet another autoscaler [[#3011](#3011)] - Add cookbook blog and improve docs [[#3002](#3002)] - Replace multi-pipelines with workflows on docs frontpage [[#2990](#2990)] - Update README badges [[#2956](#2956)] - Update 20-kubernetes.md [[#2927](#2927)] - Add release documentation to CONTRIBUTING [[#2917](#2917)] - Add nix-attic plugin to the index [[#2889](#2889)] - Add usage with Tunnelmole to docs [[#2881](#2881)] - Improve code blocks in docs [[#2879](#2879)] - Add a blog post [[#2877](#2877)] - Add documentation on Kubernetes securityContext [[#2822](#2822)] - Add default page to categories [[#2869](#2869)] - Use same format for Github docs as used for the other forges [[#2866](#2866)] ### Misc - chore(deps): update dependency isomorphic-dompurify to v2 [[#3001](#3001)] - fix(deps): update dependency @intlify/unplugin-vue-i18n to v2 [[#2998](#2998)] - Fix go in gitpod [[#2973](#2973)] - fix(deps): update module google.golang.org/grpc to v1.60.1 [[#2969](#2969)] - chore(deps): update docker.io/alpine docker tag to v3.19 [[#2970](#2970)] - Fix broken gated repos [[#2959](#2959)] - fix(deps): update golang (packages) [[#2958](#2958)] - Update docker.io/techknowlogick/xgo Docker tag to go-1.21.5 [[#2926](#2926)] - Update docker.io/golang Docker tag to v1.21.5 [[#2925](#2925)] - Lock file maintenance [[#2910](#2910)] - Update web npm deps non-major [[#2909](#2909)] - Update docs npm deps non-major [[#2908](#2908)] - Update golang (packages) [[#2904](#2904)] - Update module github.com/google/go-github/v56 to v57 [[#2899](#2899)] - Update dependency marked to v11 [[#2898](#2898)] - Update dependency vite-svg-loader to v5 [[#2837](#2837)] - Update golang (packages) [[#2894](#2894)] - Update web npm deps non-major [[#2895](#2895)] - Update web npm deps non-major [[#2884](#2884)] - Update docker.io/woodpeckerci/plugin-docker-buildx Docker tag to v2.2.1 [[#2883](#2883)]

[CI] docs: lint swagger file

c79002e

6543 force-pushed the lint-swagger-json branch from 1d57eed to c79002e Compare December 23, 2023 22:48

remove host form swagger doc

c8211b2

6543 added bug Something isn't working documentation docu & docs labels Dec 24, 2023

6543 changed the title ~~[CI] docs: lint swagger file~~ fix and lint swagger file Dec 24, 2023

6543 commented Dec 24, 2023

View reviewed changes

cmd/server/woodpecker_docs_gen.go Outdated Show resolved Hide resolved

no nice format

5cd6173

6543 added 3 commits December 24, 2023 01:59

add more validation

b2d1836

fix some swagger doc

087b741

generate swagger

a38a51d

6543 requested a review from a team December 24, 2023 02:15

6543 added 2 commits December 24, 2023 11:27

we use go generate cmd/server/swagger.go to validate

9cf9025

Merge branch 'main' into lint-swagger-json

f92d4f5

6543 added this to the 2.1.0 milestone Dec 24, 2023

Merge branch 'main' into lint-swagger-json

fab581d

Merge branch 'main' into lint-swagger-json

212b621

Reformat swagger comments

0c46689

Merge pull request #4 from qwerty287/lint-swagger-json

f2448ff

Reformat swagger comments

qwerty287 approved these changes Dec 24, 2023

View reviewed changes

Merge branch 'main' into lint-swagger-json

53a473e

6543 enabled auto-merge (squash) December 24, 2023 14:38

6543 merged commit 3f1f563 into woodpecker-ci:main Dec 24, 2023
6 checks passed

woodpecker-bot mentioned this pull request Dec 24, 2023

🎉 Release 2.1.0 #2868

Merged

1 task

6543 deleted the lint-swagger-json branch December 24, 2023 14:51

BrewTestBot mentioned this pull request Dec 26, 2023

woodpecker-cli 2.1.0 Homebrew/homebrew-core#158332

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix and lint swagger file #3007

fix and lint swagger file #3007

6543 commented Dec 23, 2023

woodpecker-bot commented Dec 24, 2023 •

edited

Loading

codecov bot commented Dec 24, 2023 •

edited

Loading

qwerty287 commented Dec 24, 2023

6543 commented Dec 24, 2023

6543 commented Dec 24, 2023

6543 commented Dec 24, 2023

qwerty287 commented Dec 24, 2023 •

edited

Loading

6543 commented Dec 24, 2023

qwerty287 commented Dec 24, 2023

6543 commented Dec 24, 2023

qwerty287 commented Dec 24, 2023

6543 commented Dec 24, 2023

qwerty287 commented Dec 24, 2023 •

edited

Loading

fix and lint swagger file #3007

fix and lint swagger file #3007

Conversation

6543 commented Dec 23, 2023

woodpecker-bot commented Dec 24, 2023 • edited Loading

codecov bot commented Dec 24, 2023 • edited Loading

Codecov Report

qwerty287 commented Dec 24, 2023

6543 commented Dec 24, 2023

6543 commented Dec 24, 2023

6543 commented Dec 24, 2023

qwerty287 commented Dec 24, 2023 • edited Loading

6543 commented Dec 24, 2023

qwerty287 commented Dec 24, 2023

6543 commented Dec 24, 2023

qwerty287 commented Dec 24, 2023

6543 commented Dec 24, 2023

qwerty287 commented Dec 24, 2023 • edited Loading

woodpecker-bot commented Dec 24, 2023 •

edited

Loading

codecov bot commented Dec 24, 2023 •

edited

Loading

qwerty287 commented Dec 24, 2023 •

edited

Loading

qwerty287 commented Dec 24, 2023 •

edited

Loading