Conversation
Signed-off-by: Dorin Geman <dorin.geman@docker.com>
Signed-off-by: Dorin Geman <dorin.geman@docker.com>
Signed-off-by: Dorin Geman <dorin.geman@docker.com>
|
Note Gemini is unable to generate a summary for this pull request due to the file types involved not being currently supported. |
There was a problem hiding this comment.
Hey - I've found 1 issue, and left some high level feedback:
- In the
Summarystep, consider collapsing the repeatedechocalls into a single here-doc (e.g.,cat <<EOF >> "$GITHUB_STEP_SUMMARY") to make the table definition easier to maintain and less error-prone. - Now that
releaseTagis required and used directly in Docker tags, you might want to add a small validation step (e.g., regex check) to fail fast if an invalid tag string is provided rather than letting the Docker build/push fail later.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- In the `Summary` step, consider collapsing the repeated `echo` calls into a single here-doc (e.g., `cat <<EOF >> "$GITHUB_STEP_SUMMARY"`) to make the table definition easier to maintain and less error-prone.
- Now that `releaseTag` is required and used directly in Docker tags, you might want to add a small validation step (e.g., regex check) to fail fast if an invalid tag string is provided rather than letting the Docker build/push fail later.
## Individual Comments
### Comment 1
<location> `.github/workflows/release.yml:42-52` </location>
<code_context>
steps:
+ - name: Summary
+ run: |
+ echo "## Release Parameters" >> $GITHUB_STEP_SUMMARY
+ echo "| Parameter | Value |" >> $GITHUB_STEP_SUMMARY
+ echo "|-----------|-------|" >> $GITHUB_STEP_SUMMARY
+ echo "| Release Tag | \`${{ inputs.releaseTag }}\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| Push Latest | \`${{ inputs.pushLatest }}\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| llama-server Version | \`${{ inputs.llamaServerVersion }}\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| vLLM Version | \`${{ inputs.vllmVersion }}\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| SGLang Version | \`${{ inputs.sglangVersion }}\` |" >> $GITHUB_STEP_SUMMARY
+ echo "| Build MUSA/CANN | \`${{ inputs.buildMusaCann }}\` |" >> $GITHUB_STEP_SUMMARY
+
- name: Checkout code
</code_context>
<issue_to_address>
**suggestion (bug_risk):** Quote GITHUB_STEP_SUMMARY when appending to avoid issues with spaces or special characters in the path.
To avoid potential issues if `GITHUB_STEP_SUMMARY` ever contains spaces or special characters, please use `>> "$GITHUB_STEP_SUMMARY"` in these lines, consistent with how `"$GITHUB_OUTPUT"` is handled elsewhere.
```suggestion
- name: Summary
run: |
echo "## Release Parameters" >> "$GITHUB_STEP_SUMMARY"
echo "| Parameter | Value |" >> "$GITHUB_STEP_SUMMARY"
echo "|-----------|-------|" >> "$GITHUB_STEP_SUMMARY"
echo "| Release Tag | \`${{ inputs.releaseTag }}\` |" >> "$GITHUB_STEP_SUMMARY"
echo "| Push Latest | \`${{ inputs.pushLatest }}\` |" >> "$GITHUB_STEP_SUMMARY"
echo "| llama-server Version | \`${{ inputs.llamaServerVersion }}\` |" >> "$GITHUB_STEP_SUMMARY"
echo "| vLLM Version | \`${{ inputs.vllmVersion }}\` |" >> "$GITHUB_STEP_SUMMARY"
echo "| SGLang Version | \`${{ inputs.sglangVersion }}\` |" >> "$GITHUB_STEP_SUMMARY"
echo "| Build MUSA/CANN | \`${{ inputs.buildMusaCann }}\` |" >> "$GITHUB_STEP_SUMMARY"
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| - name: Summary | ||
| run: | | ||
| echo "## Release Parameters" >> $GITHUB_STEP_SUMMARY | ||
| echo "| Parameter | Value |" >> $GITHUB_STEP_SUMMARY | ||
| echo "|-----------|-------|" >> $GITHUB_STEP_SUMMARY | ||
| echo "| Release Tag | \`${{ inputs.releaseTag }}\` |" >> $GITHUB_STEP_SUMMARY | ||
| echo "| Push Latest | \`${{ inputs.pushLatest }}\` |" >> $GITHUB_STEP_SUMMARY | ||
| echo "| llama-server Version | \`${{ inputs.llamaServerVersion }}\` |" >> $GITHUB_STEP_SUMMARY | ||
| echo "| vLLM Version | \`${{ inputs.vllmVersion }}\` |" >> $GITHUB_STEP_SUMMARY | ||
| echo "| SGLang Version | \`${{ inputs.sglangVersion }}\` |" >> $GITHUB_STEP_SUMMARY | ||
| echo "| Build MUSA/CANN | \`${{ inputs.buildMusaCann }}\` |" >> $GITHUB_STEP_SUMMARY |
There was a problem hiding this comment.
suggestion (bug_risk): Quote GITHUB_STEP_SUMMARY when appending to avoid issues with spaces or special characters in the path.
To avoid potential issues if GITHUB_STEP_SUMMARY ever contains spaces or special characters, please use >> "$GITHUB_STEP_SUMMARY" in these lines, consistent with how "$GITHUB_OUTPUT" is handled elsewhere.
| - name: Summary | |
| run: | | |
| echo "## Release Parameters" >> $GITHUB_STEP_SUMMARY | |
| echo "| Parameter | Value |" >> $GITHUB_STEP_SUMMARY | |
| echo "|-----------|-------|" >> $GITHUB_STEP_SUMMARY | |
| echo "| Release Tag | \`${{ inputs.releaseTag }}\` |" >> $GITHUB_STEP_SUMMARY | |
| echo "| Push Latest | \`${{ inputs.pushLatest }}\` |" >> $GITHUB_STEP_SUMMARY | |
| echo "| llama-server Version | \`${{ inputs.llamaServerVersion }}\` |" >> $GITHUB_STEP_SUMMARY | |
| echo "| vLLM Version | \`${{ inputs.vllmVersion }}\` |" >> $GITHUB_STEP_SUMMARY | |
| echo "| SGLang Version | \`${{ inputs.sglangVersion }}\` |" >> $GITHUB_STEP_SUMMARY | |
| echo "| Build MUSA/CANN | \`${{ inputs.buildMusaCann }}\` |" >> $GITHUB_STEP_SUMMARY | |
| - name: Summary | |
| run: | | |
| echo "## Release Parameters" >> "$GITHUB_STEP_SUMMARY" | |
| echo "| Parameter | Value |" >> "$GITHUB_STEP_SUMMARY" | |
| echo "|-----------|-------|" >> "$GITHUB_STEP_SUMMARY" | |
| echo "| Release Tag | \`${{ inputs.releaseTag }}\` |" >> "$GITHUB_STEP_SUMMARY" | |
| echo "| Push Latest | \`${{ inputs.pushLatest }}\` |" >> "$GITHUB_STEP_SUMMARY" | |
| echo "| llama-server Version | \`${{ inputs.llamaServerVersion }}\` |" >> "$GITHUB_STEP_SUMMARY" | |
| echo "| vLLM Version | \`${{ inputs.vllmVersion }}\` |" >> "$GITHUB_STEP_SUMMARY" | |
| echo "| SGLang Version | \`${{ inputs.sglangVersion }}\` |" >> "$GITHUB_STEP_SUMMARY" | |
| echo "| Build MUSA/CANN | \`${{ inputs.buildMusaCann }}\` |" >> "$GITHUB_STEP_SUMMARY" |
|
How about? scripts/release-parameters.sh rather than embedded bash? We can run linters like shellcheck, we get syntax highlighting and can run more easily locally (although I understand not all of these things are suitable for running locally, the other two benefits still apply). |
|
I agree, will do! |
Test: https://github.com/docker/model-runner/actions/runs/20959387670.