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

[CI] Add auto update workflow for Dockerfile graph #11879

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

WineChord
Copy link

@WineChord WineChord commented Jan 9, 2025

This PR adds a GitHub Action workflow that automatically maintains the Dockerfile dependency graph visualization:

  • Adds .github/workflows/update-dockerfile-graph.yml which:
    • Monitors changes to Dockerfile
    • Automatically regenerates the dependency graph
    • Creates PR when graph needs updating
    • Ensures documentation stays in sync with Dockerfile changes

The workflow helps maintain accurate documentation by automatically updating the
visualization in docs/source/assets/contributing/ whenever the Dockerfile changes.

This automation reduces maintenance overhead and prevents the documentation from
becoming outdated.

Fix #11880

Copy link

github-actions bot commented Jan 9, 2025

👋 Hi! Thank you for contributing to the vLLM project.
Just a reminder: PRs would not trigger full CI run by default. Instead, it would only run fastcheck CI which starts running only a small and essential subset of CI tests to quickly catch errors. You can run other CI tests on top of those by going to your fastcheck build on Buildkite UI (linked in the PR checks section) and unblock them. If you do not have permission to unblock, ping simon-mo or khluu to add you in our Buildkite org.

Once the PR is approved and ready to go, your PR reviewer(s) can run CI to test the changes comprehensively before merging.

To run CI, PR reviewers can do one of these:

  • Add ready label to the PR
  • Enable auto-merge.

🚀

@mergify mergify bot added the ci/build label Jan 9, 2025
@WineChord WineChord changed the title ci: add docker lint and auto update dockerfile graph ci: auto update dockerfile graph Jan 9, 2025
- Add workflow to automatically regenerate Dockerfile dependency graph
- Add shellcheck fixes for better script robustness

Signed-off-by: wineandchord <[email protected]>
@WineChord WineChord changed the title ci: auto update dockerfile graph [CI] Add auto update workflow for Dockerfile graph Jan 9, 2025
Comment on lines +71 to +79
commit-message: "[Doc] Update Dockerfile dependency graph"
title: "[Doc] Update Dockerfile dependency graph"
body: |
This PR updates the Dockerfile dependency graph following changes to the Dockerfile.

- Generated by GitHub Actions workflow
- Updates visualization in docs/source/assets/contributing/

Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Copy link
Author

Choose a reason for hiding this comment

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

I carefully designed the title and commit message to resemble the existing ones.

@DarkLight1337 DarkLight1337 requested a review from khluu January 9, 2025 16:01
@hmellor
Copy link
Member

hmellor commented Apr 5, 2025

Instead of a GitHub Action, could this be written as a pre-commit hook (which is kept in tools/) which is called only when the file docker/Dockerfile is changed?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Doc]: Add GitHub Action to auto-sync Dockerfile dependency graph
2 participants