From f18a1abbf06bfbff245be7208ab5d06e884bc678 Mon Sep 17 00:00:00 2001 From: Oleg Bespalov Date: Tue, 28 Nov 2023 10:53:53 +0100 Subject: [PATCH 1/5] Release process recent changes --- .github/ISSUE_TEMPLATE/release.md | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/release.md b/.github/ISSUE_TEMPLATE/release.md index b361480ab25e..f859df8788cb 100644 --- a/.github/ISSUE_TEMPLATE/release.md +++ b/.github/ISSUE_TEMPLATE/release.md @@ -16,32 +16,28 @@ labels: ["release"] - [ ] Obtain the Release coordinator's contact from the `@k6-browser` team and co-assign the issue to them. - [ ] Create a new `release-v0.4x.0` long-lived branch and add a new release notes file using the available [template](/grafana/k6/tree/master/release%20notes/template.md) to the [repository's `release notes` folder](/grafana/k6/tree/master/release%20notes). - [ ] Go through the potential [dependencies updates](Dependencies.md) and create a dedicated PR if any of them is relevant to this release. -- [ ] Create a new `release-v0.4x.0` long-lived branch on the [k6-docs](https://github.com/grafana/k6-docs) repository. Try to keep it synchronized with `main` throughout the development cycle to prevent it from becoming outdated and to avoid numerous conflicts. - [ ] Create a new `release-v0.4x.0` long-lived branch on the [grafana/k6-DefinitelyTyped](https://github.com/grafana/k6-DefinitelyTyped) fork repository. ### Release Preparation #### ~ 1 week before the release date. -- [ ] Ensure all PRs in the `k6-docs` repository, related to new or modified functionalities introduced by the new version have been created and merged to the release branch. +- [ ] Ensure all PRs in the `k6-docs` repository, related to new or modified functionalities introduced by the new version have been created. - [ ] Ensure all PRs in the k6 repository, part of the current [milestone](https://github.com/grafana/k6/milestones), have been merged. - [ ] Open a PR with the release notes for the new version, and ask teams who might have contributed to the release (k6-browser, k6-chaos, k6-docs, k6-devrel teams, etc.) to contribute their notes and review the existing ones. - [ ] Share the release notes PR with the k6 open-source teams. Request contributions from all affected teams (k6-browser, k6-chaos, k6-docs, k6-devrel, etc.) and any other stakeholders involved in the new release. -- [ ] Open a separate PR for bumping [the k6 Go project's version](https://github.com/grafana/k6/blob/9fa50b2d1f259cdccff5cc7bc18a236d31c345ac/lib/consts/consts.go#L11). +- [ ] Open a separate PR for bumping [the k6 Go project's version](https://github.com/grafana/k6/blob/master/lib/consts/consts.go#L11). - [ ] Open a PR in the `DefinitelyTyped/DefinitelyTyped` repository, using the release branch created in the grafana/k6-DefinitelyTyped fork, to update the k6 type definitions for the new release. #### ~ 1 day before the release date. -- [ ] Open a PR from `main` in the `k6-docs` repository, archiving the current k6's JavaScript API version as per the following [instructions](https://github.com/grafana/k6-docs/wiki/Add-version-for-Javascript-API-documentation). -- [ ] Open a PR in `k6-docs` repository for the release branch containing all the merged PRs for the upcoming version. If any, resolve the conflicts with the `main` branch. +- [ ] Ensure all PRs in the `k6-docs` repository, related to new or modified functionalities introduced by the new version have been merged. ### Release Day #### Documentation -- [ ] Merge the `k6-docs` repository's JavaScript API archiving PR and rebase the rest of the branches meant for the release on top of the new state of the `main` branch. -- [ ] Merge the release PR for `k6-docs` containing all the changes related to the release. The order in which this PR is merged relative to the previous one is crucial; otherwise, the new changes might inadvertently be incorporated into previous versions. -- [ ] Ensure the last resulting k6-docs GitHub action targeting the `main` branch sees its "Check broken links" job pass. +- [ ] Open and merge a PR from `main` in the `k6-docs` repository, copying the current k6's `next` to a folder named with the k6 version (e.g. `v0.48.x`). - [ ] Publish the new [vX.Y.Z version of docs](https://github.com/grafana/k6-docs/releases/new). - [ ] Ensure the k6 repository release notes PR contains the correct links to the docs. From d4f25f0732aa0478c88e009484b0da4da88cb74d Mon Sep 17 00:00:00 2001 From: Oleg Bespalov Date: Tue, 28 Nov 2023 10:57:35 +0100 Subject: [PATCH 2/5] Release notes 'integrity' check --- .github/ISSUE_TEMPLATE/release.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/ISSUE_TEMPLATE/release.md b/.github/ISSUE_TEMPLATE/release.md index f859df8788cb..abfce236553a 100644 --- a/.github/ISSUE_TEMPLATE/release.md +++ b/.github/ISSUE_TEMPLATE/release.md @@ -22,6 +22,7 @@ labels: ["release"] #### ~ 1 week before the release date. +- [ ] Ensure that all merged pull-requests referenced in the release notes are linked to the release milestone. - [ ] Ensure all PRs in the `k6-docs` repository, related to new or modified functionalities introduced by the new version have been created. - [ ] Ensure all PRs in the k6 repository, part of the current [milestone](https://github.com/grafana/k6/milestones), have been merged. - [ ] Open a PR with the release notes for the new version, and ask teams who might have contributed to the release (k6-browser, k6-chaos, k6-docs, k6-devrel teams, etc.) to contribute their notes and review the existing ones. From 64eb18fc43c9c6bed5a50e4524b51122a81f6055 Mon Sep 17 00:00:00 2001 From: Oleg Bespalov Date: Fri, 1 Dec 2023 16:23:41 +0100 Subject: [PATCH 3/5] Documents checking of experimental modules version bumps --- .github/ISSUE_TEMPLATE/release.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/release.md b/.github/ISSUE_TEMPLATE/release.md index abfce236553a..2612a86de967 100644 --- a/.github/ISSUE_TEMPLATE/release.md +++ b/.github/ISSUE_TEMPLATE/release.md @@ -7,7 +7,7 @@ labels: ["release"] **Release Date**: -25th May 2023 << TODO: WRITE HERE THE UPDATED RELEASE DATE +25th May 2024 << TODO: WRITE HERE THE UPDATED RELEASE DATE ## Release Activities @@ -20,7 +20,12 @@ labels: ["release"] ### Release Preparation -#### ~ 1 week before the release date. +#### ~ 2 weeks before the release date + +- [ ] Ensure that all pull-request from a release milestone are merged. +- [ ] Ensure that browser and other experimental modules (if needed) have been updated to their latest version. + +#### ~ 1 week before the release date - [ ] Ensure that all merged pull-requests referenced in the release notes are linked to the release milestone. - [ ] Ensure all PRs in the `k6-docs` repository, related to new or modified functionalities introduced by the new version have been created. @@ -30,7 +35,7 @@ labels: ["release"] - [ ] Open a separate PR for bumping [the k6 Go project's version](https://github.com/grafana/k6/blob/master/lib/consts/consts.go#L11). - [ ] Open a PR in the `DefinitelyTyped/DefinitelyTyped` repository, using the release branch created in the grafana/k6-DefinitelyTyped fork, to update the k6 type definitions for the new release. -#### ~ 1 day before the release date. +#### ~ 1 day before the release date - [ ] Ensure all PRs in the `k6-docs` repository, related to new or modified functionalities introduced by the new version have been merged. From ec844b7df0fb03002d9612298d51c3fc387da93d Mon Sep 17 00:00:00 2001 From: Oleg Bespalov Date: Wed, 6 Dec 2023 13:28:17 +0100 Subject: [PATCH 4/5] Clean up docs stage --- .github/ISSUE_TEMPLATE/release.md | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/release.md b/.github/ISSUE_TEMPLATE/release.md index 2612a86de967..4f03e19e9dc5 100644 --- a/.github/ISSUE_TEMPLATE/release.md +++ b/.github/ISSUE_TEMPLATE/release.md @@ -44,7 +44,6 @@ labels: ["release"] #### Documentation - [ ] Open and merge a PR from `main` in the `k6-docs` repository, copying the current k6's `next` to a folder named with the k6 version (e.g. `v0.48.x`). -- [ ] Publish the new [vX.Y.Z version of docs](https://github.com/grafana/k6-docs/releases/new). - [ ] Ensure the k6 repository release notes PR contains the correct links to the docs. #### In k6 repository From ef2c91f4108eda9354da1df289ae3824adb4b542 Mon Sep 17 00:00:00 2001 From: Oleg Bespalov Date: Thu, 7 Dec 2023 12:35:39 +0100 Subject: [PATCH 5/5] Apply suggestions from code review Co-authored-by: Ivan <2103732+codebien@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/release.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/release.md b/.github/ISSUE_TEMPLATE/release.md index 4f03e19e9dc5..930fc70f6df3 100644 --- a/.github/ISSUE_TEMPLATE/release.md +++ b/.github/ISSUE_TEMPLATE/release.md @@ -22,28 +22,28 @@ labels: ["release"] #### ~ 2 weeks before the release date -- [ ] Ensure that all pull-request from a release milestone are merged. +- [ ] Ensure that all pull-requests from a release milestone are merged. - [ ] Ensure that browser and other experimental modules (if needed) have been updated to their latest version. #### ~ 1 week before the release date - [ ] Ensure that all merged pull-requests referenced in the release notes are linked to the release milestone. -- [ ] Ensure all PRs in the `k6-docs` repository, related to new or modified functionalities introduced by the new version have been created. +- [ ] Ensure all pull-requests in the `k6-docs` repository, related to new or modified functionalities introduced by the new version have been created. - [ ] Ensure all PRs in the k6 repository, part of the current [milestone](https://github.com/grafana/k6/milestones), have been merged. -- [ ] Open a PR with the release notes for the new version, and ask teams who might have contributed to the release (k6-browser, k6-chaos, k6-docs, k6-devrel teams, etc.) to contribute their notes and review the existing ones. +- [ ] Open a PR with the release notes for the new version, and ask teams who might have contributed to the release (k6-browser, k6-ecosystem, k6-docs, k6-devrel teams, etc.) to contribute their notes and review the existing ones. - [ ] Share the release notes PR with the k6 open-source teams. Request contributions from all affected teams (k6-browser, k6-chaos, k6-docs, k6-devrel, etc.) and any other stakeholders involved in the new release. -- [ ] Open a separate PR for bumping [the k6 Go project's version](https://github.com/grafana/k6/blob/master/lib/consts/consts.go#L11). +- [ ] Open a separate pull-request for bumping [the k6 Go project's version](https://github.com/grafana/k6/blob/master/lib/consts/consts.go#L11). - [ ] Open a PR in the `DefinitelyTyped/DefinitelyTyped` repository, using the release branch created in the grafana/k6-DefinitelyTyped fork, to update the k6 type definitions for the new release. #### ~ 1 day before the release date -- [ ] Ensure all PRs in the `k6-docs` repository, related to new or modified functionalities introduced by the new version have been merged. +- [ ] Ensure all pull-requests in the `k6-docs` repository, related to new or modified functionalities introduced by the new version have been merged. ### Release Day #### Documentation -- [ ] Open and merge a PR from `main` in the `k6-docs` repository, copying the current k6's `next` to a folder named with the k6 version (e.g. `v0.48.x`). +- [ ] Open and merge a pull-request from `main` in the `k6-docs` repository, copying the current k6's `next` to a folder named with the k6 version (e.g. `v0.48.x`). - [ ] Ensure the k6 repository release notes PR contains the correct links to the docs. #### In k6 repository