add output steps and update docs

realm · May 31, 2024 · 893df92 · 893df92
1 parent f32fe4e
commit 893df92
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 2 deletions.
diff --git a/.github/workflows/make-release.yml b/.github/workflows/make-release.yml
@@ -60,3 +60,5 @@ jobs:
         sdk: Core
         webhook-url: ${{ secrets.SLACK_RELEASE_WEBHOOK }}
         version: ${{ steps.get-version.outputs.version }}
+    - name: Output PR URL
+      run: echo "Prepare vNext PR created: ${{ steps.vnext-pr.outputs.pull-request-url }}" >> $GITHUB_STEP_SUMMARY
diff --git a/.github/workflows/prepare-release.yml b/.github/workflows/prepare-release.yml
@@ -24,6 +24,7 @@ jobs:
         run: tools/release-init.sh ${{ inputs.version }}
         shell: bash
       - name: Create Release PR
+        id: prepare-pr
         uses: peter-evans/create-pull-request@6d6857d36972b65feb161a90e484f2984215f83e #! 6.0.5
         with:
           branch: release/automated_v${{ inputs.version }}
@@ -37,3 +38,5 @@ jobs:
             dependencies.yml
             Package.swift
             CHANGELOG.md
+      - name: Output PR URL
+        run: echo "Prepare release PR created: ${{ steps.prepare-pr.outputs.pull-request-url }}" >> $GITHUB_STEP_SUMMARY
diff --git a/doc/development/how-to-release.md b/doc/development/how-to-release.md
@@ -1,8 +1,8 @@
 The core release process is automated with github [actions](https://github.com/realm/realm-core/actions)
 
 1. Go to the prepare-release [action](https://github.com/realm/realm-core/actions/workflows/prepare-release.yml) and click the "Run workflow" dropdown.
-  - Input the base branch that you would like to make a release from (usually this will be "master").
-  - Input the release version (eg. "10.14.7")
+  - Select the base branch that you would like to make a release from (usually this will be "master") in the drop down.
+  - Enter the version of the new release (eg. "10.123.1" or "4.5.0-CustDemo")
 
 2. This will create a PR, which you should look over and get someone else on the team to review. Verify the changelog by checking the PR description which has a list of commits since the last tag was made. If any changes are required, commit them to this PR's branch.