k6 release v0.54.0

[olegbespalov]

Release Date:

30th September 2024

Release Activities

At the beginning of the cycle

• Obtain the Release coordinator's contact from the @k6-browser team and co-assign the issue to them.
• Create a new release-v0.5x.0 long-lived branch and add a new release notes file using the available template to the repository's release notes folder.
  • https://github.com/grafana/k6/tree/release-v0.54.0
• Go through the potential dependencies updates and create a dedicated PR if any of them is relevant to this release.
• Create a new release-v0.5x.0 long-lived branch on the grafana/k6-DefinitelyTyped fork repository.
  • Bump the version in types/k6/package.json to the next one.
  • https://github.com/grafana/k6-DefinitelyTyped/tree/release-v0.54.0

Release Preparation

~ 2 weeks before the release date

• 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 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, have been merged.
• Open a PR with the release notes for the new version
  • 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.
  • Remember to mention and thank external contributors.
• 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 pull-request for bumping the k6 Go project's version.
• 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.
  • k6: bump version of k6 to v0.54  DefinitelyTyped/DefinitelyTyped#70645
  • Add type definitions for the k6 experimental csv module k6-DefinitelyTyped#65
  • Remove k6's experimental/browser from type definitions k6-DefinitelyTyped#63

~ 1 day before the release date

• Ensure all pull-requests in the k6-docs repository, related to new or modified functionalities introduced by the new version have been merged.
  • Document gRPC stram message's metadata k6-docs#1735
  • Document the k6 cloud upload command k6-docs#1734
  • Document k6 cloud run --local-execution k6-docs#1732
  • Remove documentation for k6/experimental/timers k6-docs#1723
  • Documents that setup timeout accepts only positive values k6-docs#1720
  • Document Params.discardResponseMessage gRPC's option k6-docs#1706
  • Document OTEL HTTP Endpoint requirements k6-docs#1738
  • Document changes around usage collection k6-docs#1722

Release Day

Documentation

• 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).
  • Release v0.54.x documentation k6-docs#1750
• Ensure the k6 repository release notes PR contains the correct links to the docs.

In k6 repository

• Merge the PR bumping the k6 Go project's version Bump Version to v0.54.0 #3948
• Merge the release notes PR Release Notes for v0.54.0 #3949
• Pull locally the previously merged changes.
• Create and push a new tag of the form vX.Y.Z using git: git tag v0.5x.0 -m "v0.5x.0".

Announcements

• Publish a link to the new GitHub release in the #k6-changelog channel.
• Notify the larger team in the #k6 channel, letting them know that the release is published.
• Close the release's milestone.

Wrapping Release

• Ensure the DefinitelyTyped/DefinitelyTyped PR(s) are merged.
  • k6: bump version of k6 to v0.54  DefinitelyTyped/DefinitelyTyped#70645
  • Add type definitions for the k6 experimental csv module k6-DefinitelyTyped#65
  • Remove k6's experimental/browser from type definitions k6-DefinitelyTyped#63
• Update the k6 repository's .github/ISSUE_TEMPLATE/release.md in the event steps from this checklist were incorrect or missing.