add more details about making a release#688
Conversation
|
Warning Rate limit exceeded
You’ve run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThis PR standardizes agent task worktree paths to ChangesWorktree Path Standardization
Release Procedure Documentation
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 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 |
![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 (1)
docs/contributing/publish_a_new_release.qmd (1)
36-38: ⚡ Quick winAdd canonical conda-forge bot-command reference (“@conda-forge-admin, please update version”) to prevent doc drift
In
docs/contributing/publish_a_new_release.qmd(lines 36-38), add a link to conda-forge’s official documentation that defines the exact bot-trigger issue title: https://conda-forge.org/docs/maintainer/infrastructure/ (optionally also https://conda-forge.org/docs/maintainer/updating_pkgs/).🤖 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 `@docs/contributing/publish_a_new_release.qmd` around lines 36 - 38, Update the paragraph that mentions the bot command by replacing or augmenting the plain text "`@conda-forge-admin`, please update version" with a canonical reference to conda-forge documentation: link that phrase to https://conda-forge.org/docs/maintainer/infrastructure/ (and optionally also add https://conda-forge.org/docs/maintainer/updating_pkgs/), so readers can click the exact bot-command guidance; locate the string "`@conda-forge-admin`, please update version" in publish_a_new_release.qmd and add the links inline near that sentence.
🤖 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 `@docs/contributing/publish_a_new_release.qmd`:
- Line 21: Replace the incorrect phrase "includes and agent skill" with
"includes an agent skill" in the sentence that reads "Also note, DASCore
includes and agent skill called "draft release"" so the guidance reads
"...DASCore includes an agent skill called "draft release"..." to fix the
grammar typo.
---
Nitpick comments:
In `@docs/contributing/publish_a_new_release.qmd`:
- Around line 36-38: Update the paragraph that mentions the bot command by
replacing or augmenting the plain text "`@conda-forge-admin`, please update
version" with a canonical reference to conda-forge documentation: link that
phrase to https://conda-forge.org/docs/maintainer/infrastructure/ (and
optionally also add https://conda-forge.org/docs/maintainer/updating_pkgs/), so
readers can click the exact bot-command guidance; locate the string
"`@conda-forge-admin`, please update version" in publish_a_new_release.qmd and add
the links inline near that sentence.
🪄 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: 47dd1f82-5fdb-47b3-816c-495a888c0888
📒 Files selected for processing (3)
.agents/agents.md.agents/skills/start_task/SKILL.mddocs/contributing/publish_a_new_release.qmd
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 6da4296760
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| The GitHub releases page can generate release notes automatically, but maintainers should review and edit the generated text so it is useful to users. Also note, DASCore includes and agent skill called "draft release" so a coding agent of your choice can help you do this. In the changelog, prefer concise descriptions of behavior and API changes over internal implementation details. Include pull request links when they help readers find more context. | ||
|
|
||
| Then click 'Publish Release'. This will kick off the doc-build and publishing task automatically, as well as publish the tagged source code to PyPI. |
There was a problem hiding this comment.
This sentence says clicking Publish Release will start both package and docs publishing automatically, but the workflows are wired to different release events: PublishPackage listens to release.published (.github/workflows/upload_pypi.yml:3-6) while BuildDeployStableDocs listens to release.created (.github/workflows/build_deploy_stable_docs.yaml:4-7). Since the preceding step instructs maintainers to draft first and then publish, maintainers can follow this page and not get the stable docs deployment they are told to expect.
Useful? React with 👍 / 👎.
1 participant
Description
This PR adds more details about making a DASCore release. It is purely a documentation update.
Checklist
I have (if applicable):
Summary by CodeRabbit