Skip to content

Conversation

@thaJeztah
Copy link
Member

@thaJeztah thaJeztah commented May 10, 2022

Opening as draft, as it's not yet released; I'll rebase once the above PR is merged

@thaJeztah thaJeztah added the area/engine Issue affects Docker engine/daemon label May 10, 2022
@netlify
Copy link

netlify bot commented May 10, 2022

Deploy Preview for docsdocker ready!

Name Link
🔨 Latest commit 90ea1e7
🔍 Latest deploy log https://app.netlify.com/sites/docsdocker/deploys/6283b3d9161583000848bc76
😎 Deploy Preview https://deploy-preview-14709--docsdocker.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@usha-mandya usha-mandya requested a review from dockertopia May 10, 2022 09:48
@thaJeztah thaJeztah force-pushed the engine_release_notes branch from c8f57d4 to f0e2c21 Compare May 12, 2022 09:33
@thaJeztah thaJeztah force-pushed the engine_release_notes branch from f0e2c21 to b0fa749 Compare May 12, 2022 14:21
## 20.10.16
2022-05-12

This release of Docker Engine fixes a regression in the Docker CLI builds for
Copy link
Contributor

@dockertopia dockertopia May 12, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I get the idea of doing a quick summary at the top, especially for a scenario of a "what's new" and dealing with new features, but this is a short list of items and info is repeated and close by below this paragraph. Just wondering if it is necessary.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, tried to stick with the format we used. I agree that for shorter change logs it's a bit redundant (although the summary can sometimes be written slightly more, well, as a summary, without the nitty-gritty details if people don't need them).

### Client

- Fix a regression in binaries for macOS introduced in [20.10.15](#201015), which
resulted in a panic [docker/cli#43426](https://github.com/docker/cli/pull/3592){:target="_blank" rel="noopener"}.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
resulted in a panic [docker/cli#43426](https://github.com/docker/cli/pull/3592){:target="_blank" rel="noopener"}.
resulted in a panic [docker/cli #43426](https://github.com/docker/cli/pull/3592){:target="_blank" rel="noopener"}.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it becomes more readable with a space between repo and issue nr.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know we used this format for all change-logs, and we picked this format to match the format that GitHub itself uses.

if we decide to change, we should probably do it across the board (probably better to do that separately).

I will have to check if that could cause potential issues; GitHub can be very "eager" to try to link together issues/pull requests, which means that including certain strings in a text sometimes causes those to show up as "linked commit" on those tickets/PR's (and in some cases even send out e-mails to all participants on them).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would this be an issue for others release notes? Like I mentioned earlier there is a discussion in its very early stages about normalizing release notes across manuals. This would involve some details like mentioning dates of releases (with parenthesis in some places, without in others, past tenses used, how issue numbers are presented... individually small things, all together making pages look different).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

w.r.t. changing the format of the dates, we may have to be careful, as doing so might break the anchor-links (so we'd have to replace them with custom anchors)

But yes, if we have ideas on improving the release notes, we should try to match (where possible); probably do so all at once?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, better check first the changes we want to make across RN and then check if they have impact.

Comment on lines 50 to 51
- Use "weak" dependencies for the `docker scan` CLI plugin, so prevent errors
when performing an off-line installation from downloaded packages [docker/docker-ce-packaging#659](https://github.com/docker/docker-ce-packaging/pull/659){:target="_blank" rel="noopener"}.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had a question reading this line. Is it the meaning on the lines of " We used these dependencies to prevent offline installation errors", (seems like we're advising users) ? Or "(We) Fixed the X packages by using "weak" dependencies [...]. This prevents errors previously obtained by users in offline installations of these packages.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The latter; when installing from local packages, users could get an error; when trying to install the CLI, it failed because the docker scan plugin wasn't installed, and when trying to install the docker scan plugin, it would fail because the docker CLI was not installed;

yum install ./docker-scan-plugin-0.17.0-3.fc35.x86_64.rpm
Last metadata expiration check: 1:09:40 ago on Tue Mar  8 08:30:47 2022.
Error:
Problem: conflicting requests
- nothing provides docker-ce-cli needed by docker-scan-plugin-0.17.0-3.fc35.x86_64
  (try to add '--skip-broken' to skip uninstallable packages)

yum install ./docker-ce-cli-20.10.13-3.fc35.x86_64.rpm
Last metadata expiration check: 1:10:23 ago on Tue Mar  8 08:30:47 2022.
Error:
Problem: conflicting requests
- nothing provides docker-scan-plugin(x86-64) needed by docker-ce-cli-1:20.10.13-3.fc35.x86_64
  (try to add '--skip-broken' to skip uninstallable packages)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see I made a typo (so instead of to)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried to rephrase it a bit; let me know if the new version looks better to you

Copy link
Contributor

@dockertopia dockertopia left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other than those questions. LGTM.

@thaJeztah thaJeztah force-pushed the engine_release_notes branch from b0fa749 to 87f39f9 Compare May 12, 2022 15:23
@thaJeztah thaJeztah marked this pull request as ready for review May 12, 2022 15:24
@thaJeztah
Copy link
Member Author

@dockertopia could you have another look to see if the last iteration looks good to you? #14709 (comment)

I tried to rephrase it a bit; let me know if the new version looks better to you

@dockertopia
Copy link
Contributor

@dockertopia could you have another look to see if the last iteration looks good to you? #14709 (comment)

I tried to rephrase it a bit; let me know if the new version looks better to you

Looks great!

@thaJeztah thaJeztah reopened this May 17, 2022
@dockertopia
Copy link
Contributor

Thanks for the course correction. For me it looks great @thaJeztah.

@dockertopia dockertopia self-requested a review May 17, 2022 14:34
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
@thaJeztah thaJeztah force-pushed the engine_release_notes branch from 87f39f9 to 90ea1e7 Compare May 17, 2022 14:40
@thaJeztah
Copy link
Member Author

Applied your "past tense" suggestions 👍

@thaJeztah
Copy link
Member Author

Let me bring this one in 👍

@thaJeztah thaJeztah merged commit e5054d0 into docker:master May 18, 2022
@thaJeztah thaJeztah deleted the engine_release_notes branch May 18, 2022 10:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/engine Issue affects Docker engine/daemon

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants