fix: avoid immutable release races during asset upload#44
Merged
Conversation
WalkthroughThe PR migrates the release pipeline from manual versioning and per-OS build matrices to semantic-release driven automation. The Makefile now defines platform-specific builds with optional compression and archive generation; ChangesSemantic-release Release Pipeline Migration
Sequence DiagramsequenceDiagram
participant Push as Push to main
participant SemRel as semantic-release job
participant Binary as binary job
participant Publish as publish-release job
participant GH as GitHub Release API
Push->>SemRel: Trigger workflow
SemRel->>SemRel: Analyze commits<br/>determine next version
SemRel->>GH: Create draft release
SemRel-->>Binary: version & published flag
Binary->>Binary: make release VERSION=x.y.z
Binary->>Binary: Build linux/darwin/windows
Binary->>Binary: Compress (UPX on Linux)
Binary->>Binary: Generate SHA256 checksums
Binary->>Binary: Create archives (zip/tar.gz)
Binary->>GH: Upload artifacts to draft
Binary-->>Publish: Signal completion
Publish->>GH: Set draft=false
GH-->>Push: Release published
Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
✨ Simplify code
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
.github/workflows/release.yml (2)
25-28: ⚡ Quick winConsider disabling credential persistence for defense in depth.
The checkout action persists Git credentials by default. While the risk is low in this job, setting
persist-credentials: falseis a security best practice that prevents potential credential leakage if subsequent steps or actions are compromised.🛡️ Proposed fix
- name: Checkout uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 with: fetch-depth: 0 + persist-credentials: false🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In @.github/workflows/release.yml around lines 25 - 28, The Checkout step currently uses actions/checkout@de0fac2e... and leaves default credential persistence; update the Checkout step (the step with name "Checkout" and uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd) to add the input persist-credentials: false so GitHub credentials are not written to the workspace after checkout.
44-45: ⚡ Quick winAdd
persist-credentials: falsehere as well.Same security recommendation as the semantic-release job—disable credential persistence on checkout.
🛡️ Proposed fix
- name: Checkout uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + with: + persist-credentials: false🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In @.github/workflows/release.yml around lines 44 - 45, The Checkout step currently uses actions/checkout@de0fac2e... but does not disable credential persistence; update the Checkout job's step (the step with name "Checkout" and uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd) to include persist-credentials: false so credentials are not persisted to the workspace for subsequent steps..releaserc (1)
5-17: 💤 Low valueAll commit types mapped to
patchdeviates from semantic versioning conventions.Mapping
feattopatch(line 11) is unconventional—semantic versioning typically treats features as minor bumps. This is a valid choice if the project intentionally wants conservative versioning, but contributors familiar with standard semver may expectfeatcommits to trigger minor releases.If this is intentional, consider adding a comment in this file or documenting the versioning policy.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In @.releaserc around lines 5 - 17, The releaseRules mapping currently maps all commit types (releaseRules) including the 'feat' rule to release: patch; update the 'feat' rule inside releaseRules to release: minor to align with semver (change the entry "- { type: feat, release: patch }" to "- { type: feat, release: minor }"), or if the current conservative mapping is intentional, add a clear comment above releaseRules explaining that 'feat' is intentionally mapped to patch and documenting the project's versioning policy so contributors are not surprised.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@Makefile`:
- Around line 98-102: The Makefile recipe for target $(UPX) uses the
non-portable `trash` command for cleanup; replace that with a portable command
such as `rm -rf` to delete the downloaded archive and extracted directory.
Update the recipe under the $(UPX): .bin rule so the last line becomes `rm -rf
upx.tar.xz upx-$(UPX_VERSION)-$(TASK_ARCH)_$(TASK_PLATFORM)` (or an equivalent
safe `rm -rf` invocation) to ensure CI on Linux/Ubuntu succeeds.
---
Nitpick comments:
In @.github/workflows/release.yml:
- Around line 25-28: The Checkout step currently uses
actions/checkout@de0fac2e... and leaves default credential persistence; update
the Checkout step (the step with name "Checkout" and uses:
actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd) to add the input
persist-credentials: false so GitHub credentials are not written to the
workspace after checkout.
- Around line 44-45: The Checkout step currently uses
actions/checkout@de0fac2e... but does not disable credential persistence; update
the Checkout job's step (the step with name "Checkout" and uses:
actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd) to include
persist-credentials: false so credentials are not persisted to the workspace for
subsequent steps.
In @.releaserc:
- Around line 5-17: The releaseRules mapping currently maps all commit types
(releaseRules) including the 'feat' rule to release: patch; update the 'feat'
rule inside releaseRules to release: minor to align with semver (change the
entry "- { type: feat, release: patch }" to "- { type: feat, release: minor }"),
or if the current conservative mapping is intentional, add a clear comment above
releaseRules explaining that 'feat' is intentionally mapped to patch and
documenting the project's versioning policy so contributors are not surprised.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 13e05eb6-6d08-4fa7-a2ca-645baa42db38
📒 Files selected for processing (4)
.github/workflows/release.yml.gitignore.releasercMakefile
Release asset uploads were running from parallel matrix jobs. With immutable GitHub releases, the first matrix job to publish the release locked the asset list, causing later uploads to fail. Switching uploads to draft releases by tag also created multiple draft releases for the same tag. Use semantic-release to create one draft release, build all platform assets in one binary job, upload them with gh release upload, then publish the draft after uploads complete.
adityathebe
force-pushed
the
fix/semantic-release-draft-upload
branch
from
5d0b877 to
46baf1e
Compare
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
1 participant
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.
deps failed release was blocking this PR: flanksource/config-db#2227
Release asset uploads were running from parallel matrix jobs.
See: https://github.com/flanksource/deps/actions/runs/26118570624/job/76911704691
With immutable GitHub releases, the first matrix job to publish the release locked the asset list, causing later uploads to fail. Switching uploads to draft releases by tag also created multiple draft releases for the same tag.
Use semantic-release to create one draft release, build all platform assets in one binary job, upload them with
gh release upload, then publish the draft after uploads complete.Follow the same pattern as mission-control.
Summary by CodeRabbit