Skip to content

Latest commit

 

History

History
278 lines (190 loc) · 14.5 KB

RELEASE.md

File metadata and controls

278 lines (190 loc) · 14.5 KB
Raw

Release process for Podman Desktop

Pre-requisites

  • Create Enhancement Issue Release vX.X.X for current sprint, then update the label to kind/release and assign it to yourself.
  • Confirm with Podman Desktop maintainers that pending / need-to-go-in PR's have been merged.
  • Notify main contributors on Discord / Slack.
  • Release notes for the blog: Communicate with the person who has been tasked with creating the documentation. If you are assigned, see the below "Documentation" section.

In the below example, we will pretend that we're upgrading from 0.11.0 to 0.12.0. Please use the CORRECT release numbers as these are just example numbers.

Release timeline

Below is what a typical release week may look like:

  • Monday (Notify): 48-hour notification. Communicate to maintainers and public channels a release will be cut on Wednesday and to merge any pending PRs. Inform QE team. Start work on blog post as it is usually the longest part of the release process.
  • Tuesday (Staging, Testing & Blog): Stage the release (see instructions below) to create a new cut of the release to test. Test the pre-release (master branch) build briefly. Get feedback from committers (if applicable). Push the blog post for review (as it usually takes a few back-and-forth reviews on documentation).
  • Wednesday (Release): Cut the new release using the below release process. The release will take 24 hours for release to hit all release channels (Flatpak, Brew, Chocolatey, etc.). We aim to have a release out by Thursday so we do not have any surprises leading into the weekend.
  • Thursday (Post-release Testing & Blog): Test the post-release build briefly for any critical bugs. Confirm that new release has been pushed to all release channels. Push the blog post live. Get a known issues list together from QE and publish to the Podman Desktop Discussions, link to this from the release notes.
  • Friday (Communicate): Friday is statistically the best day for new announcements. Post on internal channels. Post on reddit, hackernews, twitter, etc.

Releasing on GitHub

  1. Go to https://github.com/containers/podman-desktop/actions/workflows/release.yaml
  2. Click on the top right drop-down menu Run workflow
  3. Enter the name of the release. Example: 0.12.0 (DO NOT use the v prefix like v0.12.0)
  4. Specify the branch to use for the new release. It's main for all major releases. For a bugfix release, you'll select a different branch.
  5. Click on the Run workflow button.
  6. Note: Run workflow takes approximately 30-50 minutes. Brew a coffee, work on the release notes, and/or complete the next two steps while you wait.
  7. Close the milestone for the respective release, make sure that all tasks within the milestone are completed / updated before closing. https://github.com/containers/podman-desktop/milestones
  8. If not already created, click on New Milestone and create a new milestone for the NEXT release.
  9. Check that https://github.com/containers/podman-desktop/actions/workflows/release.yaml has been completed. Sometimes it will flake, so you may need to re-run it.
  10. There should be an automated PR that has been created. Approve this and set to auto-merge. This will be automatically merged in after all tests have been ran (takes 10-30 minutes). The title looks like chore: 📢 Bump version to 0.13.0. Rerun workflow manually if some of e2e tests are failing.
  11. Above PR MUST be merged before continuing with the steps.
  12. Edit the new release https://github.com/containers/podman-desktop/releases/edit/v0.12.0
  13. Select previous tag (v0.11.0) and click on Generate release notes and the click on Update release

Test release before it is rolling out.

The release is a pre-release, it means it is not yet the latest version, so no clients will automatically update to this version.

It allows QE (and everyone else) to test these binaries before they go live or are in the package managers.

At this step, generates as well Flathub pull request so people can test the package from the builders of the pull request.

Next phase

  • ❌ All severe bugs and regressions are investigated and discussed. If we agree any should block the release, need to fix the bugs and do a respin of the release with a new .z release like 1.3.1 instead of 1.3.0.

Create a branch if it does not exist. For example 1.3.x if 1.3.0 failed. Then, cherry-pick bugfixes in that branch.

  • ✅ If committers agree we have a green light, proceed. Do not forget to change the release from 'pre-release' to 'latest release' before proceeding.

Updating package managers (Brew, Winget, Chocolatey, Flathub)

Pre-requisites:

Brew

Publish to brew. The workflow will create an automated PR to the brew cask repository https://github.com/Homebrew/homebrew-cask/

  1. Go to https://github.com/containers/podman-desktop/actions/workflows/publish-to-brew.yaml
  2. Click on the top right drop-down Run workflow
  3. Select the release (under tags), which would be v0.12.0
  4. Enter the release version 0.12.0. DO NOT add the v
  5. Click Run workflow

You can view the PR at: https://github.com/Homebrew/homebrew-cask/pulls?q=is%3Apr+podman-desktop

Winget

Publish to winget. The workflow will create an automated PR to the Winget pkgs repository https://github.com/microsoft/winget-pkgs/

  1. Go to https://github.com/containers/podman-desktop/actions/workflows/publish-to-winget.yaml
  2. Click on the top right drop-down Run workflow
  3. Select the release (under tags), which would be v0.12.0
  4. Enter the release version 0.12.0. DO NOT add the v
  5. Click Run workflow

You can view the PR at: https://github.com/microsoft/winget-pkgs/pulls?q=is%3Apr+podman-desktop

Chocolatey

Publish to chocolatey. The workflow will create an automatic submission to the chocolatey site at https://community.chocolatey.org/packages/podman-desktop/#versionhistory

  1. Go to https://github.com/containers/podman-desktop/actions/workflows/publish-to-chocolatey.yaml
  2. Click on the top right drop-down Run workflow
  3. Select the release (under tags), which would be v0.12.0
  4. Enter the release version 0.12.0. DO NOT add the v
  5. Click Run workflow

Afterwards, you'll have to:

You can view the progress at: https://community.chocolatey.org/packages/podman-desktop/0.12.0

Flathub

  1. Fork the repository https://github.com/flathub/io.podman_desktop.PodmanDesktop and clone your repository (example https://github.com/benoitf/io.podman_desktop.PodmanDesktop)
  2. Edit the file: io.podman_desktop.PodmanDesktop.yml
  3. Replace url: https://github.com/containers/podman-desktop/archive/refs/tags/vXXX.tar.gz by the correct version (0.12.0)
  4. Download the package: wget https://github.com/containers/podman-desktop/archive/refs/tags/v0.12.0.tar.gz or curl -O -L https://github.com/containers/podman-desktop/archive/refs/tags/v0.12.0.tar.gz
  5. Get the SHA256: shasum -a 256 v0.12.0.tar.gz
  6. Update io.podman_desktop.PodmanDesktop.yml with the new SHA256.
  7. Unpack the tar: tar zxf v0.12.0.tar.gz
  8. Run the command (updating the 0.12.0 volume mount path) 
    podman run --rm -it -v $(pwd)/podman-desktop-0.12.0:/podman quay.io/podman-desktop/flatpak-node-generator yarn /podman/yarn.lock -o /podman/generated-sources.json
    or (for Windows users) 
    podman run --rm -it -v %CD%\podman-desktop-0.12.0:/podman quay.io/podman-desktop/flatpak-node-generator yarn /podman/yarn.lock -o /podman/generated-sources.json
    or (for 🐧 Linux users) 
    podman run --rm -it -v %CD%\podman-desktop-0.12.0:/podman:z quay.io/podman-desktop/flatpak-node-generator yarn /podman/yarn.lock -o /podman/generated-sources.json
  9. Copy the file $(pwd)/podman-desktop-0.12.0/generated-sources.json to generated-sources.json
  10. Only commit the files:
  • generated-sources.json
  • io.podman_desktop.PodmanDesktop.yml
  1. Create a PR to the repository with a title like feat: bump to v0.11.0
  2. If the PR passes all tests, merge the PR

Documentation

Release notes

You can generate "draft" release notes by using the release notes workflow. This will go through each PR and look for the // release-notes comment, in order to automatically generate release notes. Note: If no one has added release note comments, the script will result in a blank file.

  1. Use an example template for the release notes.
  2. Create a PR to the blog folder of the website using the file format: website/blog/2023-07-12-release-0.13.md
  3. Example of request when using gh cli tool for 1.9.0 milestone: gh pr list --limit 300 --repo "containers/podman-desktop" --search "state:closed milestone:1.9.0" --json title,number,url --template '{{range .}}- {{.title}} [#{{.number}}]({{.url}}){{"\n"}}{{end}}'
  4. Add any images to the website/img/podman-desktop-release-0.13 folder.
  5. Ping the respective docs maintainers for a review before merging.

Updating the podman.io website

The below workflow will create a PR for the Podman website by updating the version number.

  1. Go to https://github.com/containers/podman-desktop/actions/workflows/publish-to-podman_io.yaml
  2. Click on the top right drop-down Run workflow
  3. Select the release (under tags), which would be v1.2.0
  4. Enter the release version 1.2.0. DO NOT add the v
  5. Click Run workflow
  6. Check that the PR has been created after the workflow at https://github.com/containers/podman.io/pull/

Announcements

Release notes

  1. Double check with the Project Manager / Technical lead that the release notes are ready
  2. Merge the release notes (there should be a pending PR such as: Release notes 0.12), this will now be published on the blog.

Github discussions

  1. Create a new announcement at https://github.com/containers/podman-desktop/discussions
  2. Example template:
Hello,

A new release of Podman Desktop is out: [v0.11.0](https://github.com/containers/podman-desktop/milestone/12?closed=1)

Download it from the [download section](https://podman-desktop.io/downloads) of the [Podman Desktop website](https://podman-desktop.io/)

Release Notes are available at https://podman-desktop.io/blog/podman-desktop-release-0.11

Full Changelog is available at https://github.com/containers/podman-desktop/releases/tag/v0.11.0

Create a post on Reddit

An example of a previous post: https://www.reddit.com/r/podman/comments/10moat6/a_new_version_of_podman_desktop_is_out_v0110/

  1. Click create post on the Podman subreddit.
  2. Title it: A new version of Podman Desktop is out: v0.12.0
  3. Copy over release notes (markdown works on Reddit)

Email announcement

  1. Send email to devtools-team at redhat.com, Podman-Desktop at redhat.com
  2. Send email to product-announce at redhat.com (high level)
  3. Send email to podman-desktop at lists.podman.io (no links to Red Hat internal slack, etc.)

Release notes template

---
title: Release Notes - Podman Desktop X.X
description: Podman Desktop X.X has been released!
slug: podman-desktop-release-X.X
authors: [YOURUSERNAME]
tags: [podman-desktop, release, kubernetes, openshift]
hide_table_of_contents: false
<!-- This image link is used for social media previews / thumbnails. Release images are available: https://github.com/containers/podman-desktop-internal/tree/main/release-images -->
image: /blog/img/podman-desktop-release-1.X/X.png
---

<!-- ADD IMPORT REACTPLAYER IF USING VIDEO -->
<!-- import ReactPlayer from 'react-player' -->
<!-- EXAMPLE -->
<!-- <ReactPlayer playing playsinline controls url="https://user-images.githubusercontent.com/436777/241246481-305d215f-2a5c-46e8-9cc3-ecd90a6bd2bc.mp4" /> -->

Podman Desktop X.X Release! 🎉

<!-- DESCRIBE IN ONE SENTENCE WHAT THE RELEASE WAS ABOUT -->

<!-- DESCRIBE MAIN FEATURES IN BULLET FORM -->

<!-- EXAMPLE -->
<!-- - **Podman 4.5.1**: Podman 4.5.1 now included in Windows and Mac installers. -->

Podman Desktop X.X is now available. [Click here to download it](/downloads)!

<!-- IDEALLY, ADD CARTOON SELKIE FOR RELEASE -->

<!-- EXAMPLE -->
<!-- Release images are available: https://github.com/containers/podman-desktop-internal/tree/main/release-images -->
<!-- ![Podman-desktop-1-1-hero](img/podman-desktop-release-1.1/podman-desktop-release-1.1.png) -->

---

## Release Details

<!-- DESCRIBE MAJOR CHANGES, INCLUDE IMAGES / VIDEO IF APPLICABLE -->

<!-- EXAMPLE -->
<!-- ### Podman v4.5.1 -->
<!-- Podman Desktop 1.1 moves up to [Podman 4.5.1](https://github.com/containers/podman/releases/tag/v4.5.1). -->

<!-- WHEN DESCRIBING NAVBAR SECTIONS, INCLUDE ICON -->
<!-- EXAMPLE -->
<!-- We've also added options in **<icon icon="fa-solid fa-cog" size="lg" />Settings > Preferences** to automatically check for and install extension updates. -->

---

## Other Notable Enhancements

<!-- CATCHALL SECTION FOR MINOR ENHANCEMENTS -- >
<!-- USE BULLET POINTS -->
<!-- EXAMPLE -->
<!-- - Show warning when creating a pod with two containers that use the same port [#2671](https://github.com/containers/podman-desktop/pull/2671). -->

---

## Notable Bug Fixes

<!-- CATCHALL SECTION FOR BUG FIXES -- >
<!-- USE BULLET POINTS -->
<!-- EXAMPLE -->
<!-- - Could not install extensions on Windows 10 [#2762](https://github.com/containers/podman-desktop/pull/2762). -->

---

## Community Thank You

🎉 We’d like to say a big thank you to everyone who helped to make Podman Desktop even better. In this
release we received pull requests from the following people:

<!-- INCLUDE SHOUTOUTS TO OUTSIDE CONTRIBUTORS -->
<!-- EXAMPLE -->
<!-- - [AsciiWolf](https://github.com/AsciiWolf) in [#2607 - fix typing error in Flathub name](https://github.com/containers/podman-desktop/pull/2607) and [#2609 - fix Flatpak install instructions](https://github.com/containers/podman-desktop/pull/2609) -->

---

## Final notes

<!-- EDIT BELOW VERSION NUMBERS! -->
The complete list of issues fixed in this release is available [here](https://github.com/containers/podman-desktop/issues?q=is%3Aclosed+milestone%3AX.X.0) and [here](https://github.com/containers/podman-desktop/issues?q=is%3Aclosed+milestone%3AX.X.0).

Get the latest release from the [Downloads](/downloads) section of the website and boost your development journey with Podman Desktop. Additionally, visit the [GitHub repository](https://github.com/containers/podman-desktop) and see how you can help us make Podman Desktop better.