ci(release-drafter): adopt not-ready 3-step workflow, upgrade to v2.1.0#1049
Conversation
Co-Authored-By: AJ Steers <aj@airbyte.io>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
👋 Greetings, Airbyte Team Member!Here are some helpful tips and reminders for your convenience. 💡 Show Tips and TricksTesting This PyAirbyte VersionYou can test this version of PyAirbyte using the following: # Run PyAirbyte CLI from this branch:
uvx --from 'git+https://github.com/airbytehq/PyAirbyte.git@devin/1782529307-not-ready-workflow' pyairbyte --help
# Install PyAirbyte from this branch for development:
pip install 'git+https://github.com/airbytehq/PyAirbyte.git@devin/1782529307-not-ready-workflow'PR Slash CommandsAirbyte Maintainers can execute the following slash commands on your PR:
📚 Show Repo GuidanceHelpful ResourcesCommunity SupportQuestions? Join the #pyairbyte channel in our Slack workspace. |
📝 WalkthroughWalkthroughThe release drafter workflow switches to semantic-pr-release-drafter v2.1.0, creates the draft release in a not-ready state, and uses the draft step output as the version source for the later package and attachment steps. ChangesRelease drafter workflow update
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~4 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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 |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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 @.github/workflows/release_drafter.yml:
- Line 34: The workflow uses the mutable
aaronssteers/semantic-pr-release-drafter@v2.1.0 tag in multiple places, which
should be pinned for security. Update each uses entry in release_drafter.yml to
reference the exact full-length commit SHA for semantic-pr-release-drafter and
keep the version tag as a trailing comment, so the Release Drafter job remains
reproducible and cannot be altered by a retag.
- Around line 47-53: The release-drafter workflow is pinned to an action ref
that does not exist yet, so update the uses reference in the draft release step
to a published tag or a fixed commit that is already available. Keep the rest of
the step configuration unchanged, and verify the action name
aaronsteers/semantic-pr-release-drafter resolves successfully before merging.
🪄 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: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 7f3bea94-65cd-45ea-ad9b-ced84a1948bc
📒 Files selected for processing (1)
.github/workflows/release_drafter.yml
Code Coverage OverviewLanguages: Python Python / code-coverage/pytest-fastThe overall coverage in the branch is 67%. The coverage in the branch is 65%. Show a code coverage summary of the most impacted files.
Python / code-coverage/pytest-no-credsThe overall coverage in the branch is 67%. The coverage in the branch is 65%. Show a code coverage summary of the most impacted files.
Updated |
Co-Authored-By: AJ Steers <aj@airbyte.io>
There was a problem hiding this comment.
🧹 Nitpick comments (1)
.github/workflows/release_drafter.yml (1)
47-52: 🩺 Stability & Availability | 🔵 Trivial | ⚡ Quick winCould we explicitly clear the not-ready state during finalization?
Since this step is the “banner removed” call, adding
not-ready: falseavoids relying on implicit/default action behavior, wdyt?Proposed workflow tweak
with: version: ${{ steps.draft.outputs.tag-name }} + not-ready: false attach-files: |🤖 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_drafter.yml around lines 47 - 52, The finalization step in the release drafter workflow is relying on implicit behavior for readiness state. Update the “Attach assets and finalize draft” step that uses aaronsteers/semantic-pr-release-drafter@v2.1.0 to explicitly set the not-ready flag to false in its with inputs, so the draft is clearly marked ready when the banner is removed.
🤖 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.
Nitpick comments:
In @.github/workflows/release_drafter.yml:
- Around line 47-52: The finalization step in the release drafter workflow is
relying on implicit behavior for readiness state. Update the “Attach assets and
finalize draft” step that uses aaronsteers/semantic-pr-release-drafter@v2.1.0 to
explicitly set the not-ready flag to false in its with inputs, so the draft is
clearly marked ready when the banner is removed.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 7eab2618-b7f9-47fe-8848-455d43d2eb08
📒 Files selected for processing (1)
.github/workflows/release_drafter.yml
There was a problem hiding this comment.
Pull request overview
Updates the release-drafter GitHub Actions workflow to use semantic-pr-release-drafter v2.1.0’s new not-ready flow so a draft release is created in a clearly “WIP” state while build assets are produced/uploaded, then finalized once assets are attached.
Changes:
- Upgrade
aaronsteers/semantic-pr-release-drafterfromv1.0.0tov2.1.0. - Replace the prior dry-run + create/update sequence with the 2-call “not-ready → attach-files (finalize)” workflow.
- Wire build/versioning to the new step id (
draft) output tag.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-Authored-By: AJ Steers <aj@airbyte.io>
Summary
Upgrades
semantic-pr-release-drafterfromv1.0.0tov2.1.0and adopts the newnot-readyinput to prevent admins from publishing a draft release while file assets are still being uploaded.New flow (Pattern B — 2 calls to release-drafter):
Previously the dry-run + create were separate calls; now the first call also creates the draft with a WIP banner, and the second call attaches files and removes the banner in one step.
Depends on aaronsteers/semantic-pr-release-drafter#54 being released as v2.1.0.
Requested by Aaron ("AJ") Steers (@aaronsteers).
Link to Devin session: https://app.devin.ai/sessions/601932cfa6b54ec8a6145cd9300d43aa
Summary by CodeRabbit
Important
Auto-merge enabled.
This PR is set to merge automatically when all requirements are met.
Note
Auto-merge may have been disabled. Please check the PR status to confirm.