docs: update examples in release issue teamplate
galargh committed
Dec 5, 2022 at 09:50 UTC
a1a7c987b02fa39c549dc0e8b5816370fcba326e
1 file changed
+9
-9
docs/RELEASE_ISSUE_TEMPLATE.md
+9
-9
@@ -309,7 +309,7 @@ Checklist:
309
--method GET | grep -q 'X.Y.Z-rcN'
310
echo $?
311
</details>
312
- - [ ] Cut a pre-release on [GitHub](https://github.com/ipfs/kubo/releases) ([instructions](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release), [example](https://github.com/ipfs/kubo/releases/tag/v0.16.0-rcN))
312
+ - [ ] Cut a pre-release on [GitHub](https://github.com/ipfs/kubo/releases) ([instructions](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release), [example](https://github.com/ipfs/kubo/releases/tag/vX.Y.Z-rcN))
313
- Use `vX.Y.Z-rcN` as the tag.
314
- Link to the release issue in the description.
315
- Link to the relevant [changelog](https://github.com/ipfs/kubo/blob/master/docs/changelogs/) in the description.
@@ -318,7 +318,7 @@ Checklist:
318
# create a pre-release
319
body='See the related issue: https://github.com/ipfs/kubo/issues/9319
320
321
- And the draft changelog: [docs/changelogs/v0.17.md](https://github.com/ipfs/kubo/blob/release-vX.Y.Z/docs/changelogs/v0.17.md)'
321
+ And the draft changelog: [docs/changelogs/vX.Y.md](https://github.com/ipfs/kubo/blob/release-vX.Y.Z/docs/changelogs/vX.Y.md)'
322
gh api /repos/ipfs/kubo/releases \
323
--method POST \
324
-f tag_name='vX.Y.Z-rcN' \
@@ -504,13 +504,13 @@ Checklist:
504
</details>
505
- [ ] Ensure that the artifacts are available at https://dist.ipfs.io
506
- [ ] Publish the release to [the NPM package](https://www.npmjs.com/package/go-ipfs?activeTab=versions) by running https://github.com/ipfs/npm-go-ipfs/actions/workflows/main.yml (it happens automatically but it is safe to speed up the process and kick of a run manually)
507
- - [ ] Cut the release on [GitHub](https://github.com/ipfs/kubo/releases) ([instructions](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release), [example](https://github.com/ipfs/kubo/releases/tag/v0.16.0))
507
+ - [ ] Cut the release on [GitHub](https://github.com/ipfs/kubo/releases) ([instructions](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release), [example](https://github.com/ipfs/kubo/releases/tag/v0.17.0))
508
- Use `vX.Y.Z` as the tag.
509
- Copy the relevant [changelog](https://github.com/ipfs/kubo/blob/release/docs/changelogs/) into the release description.
510
- - Keep the release notes as trim as possible (e.g. remove top headers where possible, [example](https://github.com/ipfs/kubo/releases/tag/v0.15.0))
510
+ - Keep the release notes as trim as possible (e.g. remove top headers where possible, [example](https://github.com/ipfs/kubo/releases/tag/v0.17.0))
511
<details>
512
# create the release
513
- body="$(curl --retry 5 --no-progress-meter https://raw.githubusercontent.com/ipfs/kubo/release-vX.Y.Z/docs/changelogs/v0.17.md)"
513
+ body="$(curl --retry 5 --no-progress-meter https://raw.githubusercontent.com/ipfs/kubo/release-vX.Y.Z/docs/changelogs/vX.Y.md)"
514
gh api /repos/ipfs/kubo/releases \
515
--method POST \
516
-f tag_name='vX.Y.Z' \
@@ -542,7 +542,7 @@ Checklist:
542
- [ ] IPFS Discord #ipfs-chatter
543
- [ ] FIL Slack #ipfs-chatter
544
- [ ] Matrix
545
- - [ ] Add a link from release notes to Discuss post (like we did here: https://github.com/ipfs/kubo/releases/tag/v0.15.0)
545
+ - [ ] Add a link from release notes to Discuss post (like we did here: https://github.com/ipfs/kubo/releases/tag/v0.17.0)
546
- [ ] Update the draft PR created for [interop](https://github.com/ipfs/interop) to use the new release and mark it as ready for review.
547
- [ ] Update the draft PR created for [IPFS Desktop](https://github.com/ipfs-shipyard/ipfs-desktop) to use the new release and mark it as ready for review.
548
- [ ] Update docs
@@ -560,9 +560,9 @@ Checklist:
560
- Link type: Release notes
561
- URL: https://github.com/ipfs/kubo/releases/tag/vX.Y.Z
562
- [ ] The post is live on https://blog.ipfs.io
563
- - [ ] Share the blog post
564
- - [ ] Twitter (request in Filecoin Slack channel #shared-pl-marketing-requests; [example](https://filecoinproject.slack.com/archives/C018EJ8LWH1/p1664903524843269?thread_ts=1664885305.374909&cid=C018EJ8LWH1))
565
- - [ ] [Reddit](https://reddit.com/r/ipfs)
563
+ - [ ] Share the link to the GitHub release
564
+ - [ ] Twitter (request in Filecoin Slack channel #shared-pl-marketing-requests; [example](https://filecoinproject.slack.com/archives/C018EJ8LWH1/p1664903524843269?thread_ts=1664885305.374909&cid=C018EJ8LWH1))
565
+ - [ ] [Reddit](https://reddit.com/r/ipfs)
566
- [ ] **Stage 6 - Post-Release**
567
- [ ] Merge the `release` branch back into `master`, ignoring the changes to `version.go` (keep the `-dev` version from master).
568
- [ ] Create an issue using this release issue template for the _next_ release.