Elgato_dark/podman-desktop
1
0
Fork 0
mirror of https://github.com/podman-desktop/podman-desktop synced 2026-04-21 17:47:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

docs: update release note docs (#3197)

Browse source 
* docs: update release note docs

### What does this PR do?

* Updates the release note docs with minor changes encountered as a result of doing another release.
* Adds a template for blog posting.

### Screenshot/screencast of this PR

<!-- Please include a screenshot or a screencast explaining what is doing this PR -->

N/A

### What issues does this PR fix or reference?

<!-- Please include any related issue from Podman Desktop repository (or from another issue tracker).
-->

N/A

### How to test this PR?

<!-- Please explain steps to reproduce -->

N/A

Signed-off-by: Charlie Drage <charlie@charliedrage.com>

* docs: update based on review

Signed-off-by: Charlie Drage <charlie@charliedrage.com>

---------

Signed-off-by: Charlie Drage <charlie@charliedrage.com>
This commit is contained in:
Charlie Drage 2023-07-13 14:25:21 -04:00 committed by GitHub
parent a7d0e05bb6
commit dab6fb51da
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 114 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

130
RELEASE.md
View file

@ -2,31 +2,33 @@
## Pre-requisites
- Make sure everything that needs to be in the release is there
- Notify main contributors
- Check that the PR for Release Notes is almost completed by PM. You can generate a draft release notes using this [workflow](actions/workflows/release-notes.yaml)
- 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`.
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.
## Cut a new release using the release workflow
## Releasing on GitHub
1. Go to https://github.com/containers/podman-desktop/actions/workflows/release.yaml
1. Click on the top right drop-down menu `Run workflow`
1. Enter the name of the release. Example: `0.12.0` (DO NOT use the v prefix like v0.12.0)
1. 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.
1. Click on the `Run workflow` button
1. Click on the `Run workflow` button.
1. Note: `Run workflow` takes approximatley 30-50 minutes. Brew a coffee, work on the release notes, and/or complete the next two steps while you wait.
1. Close the milestone for the respective release, make sure that all tasks within the milesetone are completed / updated before closing. https://github.com/containers/podman-desktop/milestones
1. If not already created, create a new milestone for the upcoming release after for example `0.13.0` and click on `Create milestone`
1. If not already created, click on `New Milestone` and create a new milestone for the NEXT release.
1. 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.
1. There should be an automated PR that has been created. Approve PR for the upcoming version. The title looks like `chore: 📢 Bump version to 0.13.0`
1. 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`.
1. Above PR MUST be merged before continuing with the steps.
1. Edit the new release https://github.com/containers/podman-desktop/releases/edit/v0.12.0
1. Select previous tag (v0.11.0) and click on `Generate release notes` and the click on `Update release`
## Package manager workflow
## Updating package managers (Brew, Winget, Chocolatey, Flathub)
Pre-requisites:
- Ensure the release is OK (green workflow, artifacts are there https://github.com/containers/podman-desktop/releases)
- Ensure the release is OK (green workflow, artifacts are there https://github.com/containers/podman-desktop/releases).
#### Brew
@ -77,7 +79,7 @@ You can view the progress at: https://community.chocolatey.org/packages/podman-d
1. Get the SHA256: `shasum -a 256 v0.12.0.tar.gz`
1. Update `io.podman_desktop.PodmanDesktop.yml` with the new SHA256.
1. Unpack the tar: `tar zxf v0.12.0.tar.gz`
1. Run the command (updating the volume mount path)
1. Run the command (updating the `0.12.0` volume mount path)
```sh
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
```
@ -90,24 +92,34 @@ You can view the progress at: https://community.chocolatey.org/packages/podman-d
1. Create a PR to the repository with a title like `feat: bump to v0.11.0`
1. If the PR passes all tests, merge the PR
## podman.io website
## Documentation
Publish update to the podman website at https://podman.io
### Release notes
The workflow will create an automatic submission to the podman.io site at https://github.com/containers/podman.io/pull/
You can generate "draft" release notes by using the [release notes workflow](https://github.com/containers/podman-desktop/actions/workflows/release-notes.yaml). 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](#release-notes-template) for the release notes.
1. Create a PR to the blog folder of the website using the file format: `website/blog/2023-07-12-release-0.13.md`
1. Add any images to the `website/img/podman-desktop-release-0.13` folder.
1. 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](https://podman.io) by updating the version number.
1. Go to https://github.com/containers/podman-desktop/actions/workflows/publish-to-podman_io.yaml
1. Click on the top right drop-down `Run workflow`
1. Select the release (under tags), which would be `v1.2.0`
1. Enter the release version `1.2.0`. DO NOT add the `v`
1. Click `Run workflow`
1. Check that the PR has been created after the workflow at https://github.com/containers/podman.io/pull/
## Announcement
## Announcements
#### Release notes
1. Double check with the Project Manager / Technical lead that the release notes are ready
1. Merge the release notes (there should be a pending PR such as: `Release notes 0.12`)
1. 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
@ -139,3 +151,89 @@ An example of a previous post: https://www.reddit.com/r/podman/comments/10moat6/
1. Send email to devtools-team at redhat.com, Podman-Desktop at redhat.com
1. Send email to product-announce at redhat.com (high level)
1. 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
---
<!-- ADD IMPORT REACTPLAYER IF USING VIDEO -->
<!-- import ReactPlayer from 'react-player' -->
<!-- EXAMPLE -->
<!-- <ReactPlayer playing 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 -->
<!-- ![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
sprint 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.
```