Skip to content

Document pipeline backend engine interface precisely#5583

Merged
6543 merged 6 commits into
woodpecker-ci:mainfrom
6543-forks:add-docu-for-pipeline-backend-interface
Oct 1, 2025
Merged

Document pipeline backend engine interface precisely#5583
6543 merged 6 commits into
woodpecker-ci:mainfrom
6543-forks:add-docu-for-pipeline-backend-interface

Conversation

@6543

@6543 6543 commented Oct 1, 2025

Copy link
Copy Markdown
Member

Changes:

  • Document pipeline backend engine interface precisely
  • Add debug log to docker backend on ContainerWait return values

@6543 6543 added the documentation docu & docs label Oct 1, 2025
@6543

6543 commented Oct 1, 2025

Copy link
Copy Markdown
Member Author

use:

go doc go.woodpecker-ci.org/woodpecker/v3/pipeline/backend/types.Backend

to generate the golang doc string

@codecov

codecov Bot commented Oct 1, 2025

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 0% with 6 lines in your changes missing coverage. Please review.
✅ Project coverage is 19.81%. Comparing base (9edaa1e) to head (5aa2a05).
⚠️ Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
pipeline/backend/docker/docker.go 0.00% 6 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #5583      +/-   ##
==========================================
- Coverage   19.81%   19.81%   -0.01%     
==========================================
  Files         420      420              
  Lines       39820    39823       +3     
==========================================
- Hits         7891     7889       -2     
- Misses      31220    31226       +6     
+ Partials      709      708       -1     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Comment thread pipeline/backend/types/backend.go Outdated

@qwerty287 qwerty287 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks

Comment thread pipeline/backend/types/backend.go Outdated
Comment thread pipeline/backend/types/backend.go Outdated
@6543 6543 requested a review from qwerty287 October 1, 2025 10:32
@6543 6543 enabled auto-merge (squash) October 1, 2025 10:44
@6543

6543 commented Oct 1, 2025

Copy link
Copy Markdown
Member Author

as we now have a good description of expections .... we should check our backends.

the local backend does not match that so fix is here: #5582

@6543 6543 merged commit 2a97ae9 into woodpecker-ci:main Oct 1, 2025
7 of 9 checks passed
@woodpecker-bot woodpecker-bot mentioned this pull request Oct 1, 2025
1 task
@6543 6543 deleted the add-docu-for-pipeline-backend-interface branch October 1, 2025 11:15
@woodpecker-bot woodpecker-bot mentioned this pull request Oct 2, 2025
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation docu & docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants