Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): automatic generate pipeline docs #1699

Merged
merged 2 commits into from
Feb 27, 2025

Conversation

maxgio92
Copy link
Contributor

This commit adds a make target to generate documentation for pipelines. It also makes it run during the verify github workflow, alongside the generation of documentation of melange itself.

@maxgio92 maxgio92 force-pushed the generate-pipeline-docs branch from f5b0d75 to 4c18f02 Compare December 12, 2024 17:54
@maxgio92
Copy link
Contributor Author

maxgio92 commented Dec 12, 2024

To make build package pipelines pass, the following PR is needed I think:

imjasonh
imjasonh previously approved these changes Dec 12, 2024
imjasonh
imjasonh previously approved these changes Jan 16, 2025
@maxgio92 maxgio92 force-pushed the generate-pipeline-docs branch from 655d817 to e950024 Compare January 16, 2025 13:27
@maxgio92 maxgio92 force-pushed the generate-pipeline-docs branch 2 times, most recently from e950024 to 443a630 Compare January 28, 2025 14:37
@maxgio92 maxgio92 requested a review from imjasonh January 28, 2025 15:17
philroche
philroche previously approved these changes Feb 21, 2025
auto-merge was automatically disabled February 21, 2025 14:06

Merge commits are not allowed on this repository

@philroche
Copy link
Member

Nice work. This will be very helpful

@maxgio92 maxgio92 enabled auto-merge (squash) February 27, 2025 18:10
8none1
8none1 previously approved these changes Feb 27, 2025
Copy link

@8none1 8none1 left a comment

Choose a reason for hiding this comment

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

+1

This commit adds a make target to generate documentation for pipelines.
It also makes it run during the verify github workflow, alongside the
generation of documentation of melange itself.

Signed-off-by: Massimiliano Giovagnoli <massimiliano.giovagnoli@chainguard.dev>
@maxgio92 maxgio92 force-pushed the generate-pipeline-docs branch from 443a630 to 7a0d4e2 Compare February 27, 2025 18:33
imjasonh
imjasonh previously approved these changes Feb 27, 2025
Signed-off-by: Massimiliano Giovagnoli <massimiliano.giovagnoli@chainguard.dev>
@maxgio92 maxgio92 dismissed stale reviews from imjasonh, philroche, and 8none1 via dbb04bc February 27, 2025 18:48
@maxgio92 maxgio92 merged commit ddfcb75 into chainguard-dev:main Feb 27, 2025
38 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants