Skip to content

Commit 41affca

Browse files
authored
Update release workflow documentation and remove automated PR creation step (#104)
1 parent 5543296 commit 41affca

2 files changed

Lines changed: 15 additions & 41 deletions

File tree

.github/workflows/prepare-release.yaml

Lines changed: 6 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# 1. Updates package versions in all package.json files
44
# 2. Generates changelog from git diff between main and last release tag
55
# 3. Creates a release branch and tag
6-
# 4. Opens a pull request for review
6+
# After the workflow completes, manually create a PR from the release branch to main.
77

88
name: Prepare Release
99

@@ -17,7 +17,6 @@ on:
1717

1818
permissions:
1919
contents: write
20-
pull-requests: write
2120

2221
jobs:
2322
prepare-release:
@@ -177,43 +176,6 @@ jobs:
177176
echo "branch_name=$BRANCH_NAME" >> $GITHUB_OUTPUT
178177
echo "Created branch $BRANCH_NAME and tag v${NEW_VERSION}"
179178
180-
- name: Create Pull Request
181-
env:
182-
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
183-
NEW_VERSION: ${{ steps.calc-version.outputs.new_version }}
184-
BRANCH_NAME: ${{ steps.create-branch.outputs.branch_name }}
185-
CHANGELOG_FILE: ${{ steps.changelog-diff.outputs.changelog_file }}
186-
run: |
187-
CHANGELOG_CONTENT=$(cat "$CHANGELOG_FILE")
188-
189-
# Write PR body to a temp file to avoid YAML escaping issues
190-
cat > /tmp/pr_body.md << EOF
191-
## Release v${NEW_VERSION}
192-
193-
This PR prepares the release of version **${NEW_VERSION}** for all packages.
194-
195-
**Packages Updated:**
196-
- @microsoft/durabletask-js@${NEW_VERSION}
197-
- @microsoft/durabletask-js-azuremanaged@${NEW_VERSION}
198-
199-
**Changes Since Last Release:**
200-
${CHANGELOG_CONTENT}
201-
202-
**Release Checklist:**
203-
- [ ] Review version bumps in package.json files
204-
- [ ] Review CHANGELOG.md updates
205-
- [ ] Verify CI passes
206-
- [ ] Merge this PR
207-
- [ ] After merge, the official build pipeline will produce signed artifacts
208-
- [ ] Download artifacts and publish to npm with appropriate tag
209-
EOF
210-
211-
gh pr create \
212-
--title "Release v${NEW_VERSION}" \
213-
--body-file /tmp/pr_body.md \
214-
--base main \
215-
--head "$BRANCH_NAME"
216-
217179
- name: Summary
218180
run: |
219181
NEW_VERSION="${{ steps.calc-version.outputs.new_version }}"
@@ -225,4 +187,8 @@ jobs:
225187
echo "- **Branch**: ${BRANCH_NAME}" >> $GITHUB_STEP_SUMMARY
226188
echo "- **Tag**: v${NEW_VERSION}" >> $GITHUB_STEP_SUMMARY
227189
echo "" >> $GITHUB_STEP_SUMMARY
228-
echo "A pull request has been created. Review and merge to complete the release." >> $GITHUB_STEP_SUMMARY
190+
echo "### Next Step: Create a Pull Request" >> $GITHUB_STEP_SUMMARY
191+
echo "" >> $GITHUB_STEP_SUMMARY
192+
echo "Manually create a PR from **${BRANCH_NAME}** → **main** with title: **Release v${NEW_VERSION}**" >> $GITHUB_STEP_SUMMARY
193+
echo "" >> $GITHUB_STEP_SUMMARY
194+
echo "[Create PR](https://github.com/microsoft/durabletask-js/compare/main...${BRANCH_NAME}?expand=1&title=Release+v${NEW_VERSION})" >> $GITHUB_STEP_SUMMARY

doc/release_process.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,15 @@ Use the **Prepare Release** GitHub Action to automate the release preparation pr
4949
4. **Updates CHANGELOG.md**: Adds a new version section with the discovered changes
5050
5. **Creates a release branch**: `release/vX.Y.Z`
5151
6. **Creates a release tag**: `vX.Y.Z`
52-
7. **Opens a pull request**: For review before merging to `main`
52+
53+
### After the Workflow Completes
54+
55+
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`:
56+
57+
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`
58+
2. Set the PR title to `Release vX.Y.Z`
59+
3. Review the version bumps and changelog updates
60+
4. Merge the PR after CI passes
5361

5462
After the PR is merged, follow the **Publishing** steps below to build and publish.
5563

0 commit comments

Comments
 (0)