Skip to content

Commit d38b217

Browse files
committed
docs(release): document commenting on issues after release
1 parent a5d0931 commit d38b217

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

docs/release.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,3 +56,21 @@ Once the PR has been approved and merged, you can follow these steps to release:
5656
1. Check the box to open a discussion for this release
5757
1. In Finder, within the `/zip` directory, select all the `.zip` files. Drag them from Finder to the GitHub release page to upload the assets to the release. These files are large and the upload will take some time.
5858
1. Save/publish the GitHub release
59+
60+
## Close related issues
61+
62+
Oftentimes the changelog will contain a link to an issue as reference for a particular change. Each issue needs a comment posted.
63+
64+
Open all related issues in different tabs, then for each tab repeat this process:
65+
66+
1. Scroll to the bottom and post the following comment
67+
1. Replace `v6.x.x` with the current release in both the link text and the url.
68+
1. Replace the `###` in the release discussion url with the discussion issue number
69+
70+
```
71+
Hey there! [v6.x.x](https://github.com/IBM/plex/releases/tag/v6.x.x) was just released that references this issue.
72+
73+
Comment here or join the [release discussion](https://github.com/IBM/plex/discussions/###) to provide feedback or voice concerns. Thanks!
74+
```
75+
76+
2. Close the issue if it's not already closed. If the issue is not complete, it can be reopened.

0 commit comments

Comments
 (0)