Update release workflow documentation and remove automated PR creation step#104
Update release workflow documentation and remove automated PR creation step#104YunchuWang merged 1 commit intomainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This pull request updates the release preparation workflow to remove automatic pull request creation, shifting to a manual PR creation process. The workflow previously automated PR creation using GitHub's CLI but now provides a manual link in the workflow summary instead.
Changes:
- Removed automated PR creation step from the Prepare Release workflow
- Removed
pull-requests: writepermission that is no longer needed - Updated workflow to output a clickable link in the summary for manual PR creation
- Updated documentation to reflect the new manual PR creation process
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| .github/workflows/prepare-release.yaml | Removed the "Create Pull Request" step (37 lines), removed pull-requests: write permission, and updated workflow summary to provide manual PR creation instructions with a pre-formatted link |
| doc/release_process.md | Updated documentation to reflect manual PR creation process, replacing the previous automated step with detailed instructions for creating a PR manually after workflow completion |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| The workflow summary will include a link to create a PR. You must **manually create a pull request** from the release branch (`release/vX.Y.Z`) to `main`: | ||
|
|
||
| 1. Go to the workflow run summary and click the **Create PR** link, or navigate to: `https://github.com/microsoft/durabletask-js/compare/main...release/vX.Y.Z` |
There was a problem hiding this comment.
The URL format in the documentation is inconsistent with the URL generated by the workflow. The workflow (line 194 in prepare-release.yaml) generates a URL with query parameters that pre-populate the PR title and expand the form: ?expand=1&title=Release+v${NEW_VERSION}. The documentation should match this format for consistency and better user experience, as it will pre-fill the PR title when users click the link.
| 1. Go to the workflow run summary and click the **Create PR** link, or navigate to: `https://github.com/microsoft/durabletask-js/compare/main...release/vX.Y.Z` | |
| 1. Go to the workflow run summary and click the **Create PR** link, or navigate to: `https://github.com/microsoft/durabletask-js/compare/main...release/vX.Y.Z?expand=1&title=Release+vX.Y.Z` |
Summary
What changed?
Why is this change needed?
Issues / work items
Project checklist
CHANGELOG.mdAI-assisted code disclosure (required)
Was an AI tool used? (select one)
If AI was used:
AI verification (required if AI was used):
Testing
Automated tests
Manual validation (only if runtime/behavior changed)
1.
2.
3.
Notes for reviewers