github workflows#65
Merged
Merged
Conversation
Reviewer's guide (collapsed on small PRs)Reviewer's GuideThis PR updates the release GitHub Actions workflow to ensure protoc is installed via a dedicated setup action before Go is configured and the build runs. Sequence diagram for updated release GitHub Actions workflowsequenceDiagram
participant GitHubActionsRunner as GitHubActionsRunner
participant SetupProtoc as arduino_setup_protoc_v3
participant SetupGo as actions_setup_go_v5
GitHubActionsRunner->>SetupProtoc: arduino/setup-protoc@v3
SetupProtoc-->>GitHubActionsRunner: protoc 25.x installed
GitHubActionsRunner->>SetupGo: actions/setup-go@v5
SetupGo-->>GitHubActionsRunner: Go toolchain configured
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey - I've found 1 issue, and left some high level feedback:
- Consider pinning
arduino/setup-protoc@v3to a specific commit SHA (or at least a minor version) to reduce the risk of unexpected changes in the action impacting the release workflow. - If the workflow only needs public artifacts, evaluate whether
repo-token: ${{ secrets.GITHUB_TOKEN }}is strictly required and, if so, document why the default token permissions are sufficient for this step to keep the token usage minimal.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider pinning `arduino/setup-protoc@v3` to a specific commit SHA (or at least a minor version) to reduce the risk of unexpected changes in the action impacting the release workflow.
- If the workflow only needs public artifacts, evaluate whether `repo-token: ${{ secrets.GITHUB_TOKEN }}` is strictly required and, if so, document why the default token permissions are sufficient for this step to keep the token usage minimal.
## Individual Comments
### Comment 1
<location path=".github/workflows/release.yml" line_range="55-59" />
<code_context>
workspaces: "codebase"
key: ${{ matrix.target }}
+ - name: Install protoc
+ uses: arduino/setup-protoc@v3
+ with:
+ version: "25.x"
+ repo-token: ${{ secrets.GITHUB_TOKEN }}
+
</code_context>
<issue_to_address>
**suggestion (bug_risk):** Consider pinning protoc to a specific version for reproducible builds
Using a floating version like "25.x" means builds can silently change when new minor releases are published, potentially introducing regressions. Pinning to a specific version (e.g., "25.3") keeps builds deterministic and ensures changes only occur when you explicitly update the version.
```suggestion
- name: Install protoc
uses: arduino/setup-protoc@v3
with:
# Pin protoc version for reproducible builds; update explicitly as needed
version: "25.3"
repo-token: ${{ secrets.GITHUB_TOKEN }}
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Comment on lines
+55
to
+59
| - name: Install protoc | ||
| uses: arduino/setup-protoc@v3 | ||
| with: | ||
| version: "25.x" | ||
| repo-token: ${{ secrets.GITHUB_TOKEN }} |
There was a problem hiding this comment.
suggestion (bug_risk): Consider pinning protoc to a specific version for reproducible builds
Using a floating version like "25.x" means builds can silently change when new minor releases are published, potentially introducing regressions. Pinning to a specific version (e.g., "25.3") keeps builds deterministic and ensures changes only occur when you explicitly update the version.
Suggested change
| - name: Install protoc | |
| uses: arduino/setup-protoc@v3 | |
| with: | |
| version: "25.x" | |
| repo-token: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Install protoc | |
| uses: arduino/setup-protoc@v3 | |
| with: | |
| # Pin protoc version for reproducible builds; update explicitly as needed | |
| version: "25.3" | |
| repo-token: ${{ secrets.GITHUB_TOKEN }} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by Sourcery
CI: