Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add release notes for v1.16.0-alpha.0 #1526

Conversation

wallrj
Copy link
Member

@wallrj wallrj commented Jul 24, 2024

@cert-manager-prow cert-manager-prow bot added dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jul 24, 2024
Copy link

netlify bot commented Jul 24, 2024

Deploy Preview for cert-manager ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 2d80b77
🔍 Latest deploy log https://app.netlify.com/sites/cert-manager/deploys/66a124ffbb251f0008e19477
😎 Deploy Preview https://deploy-preview-1526--cert-manager.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 configuration.

@wallrj wallrj requested a review from maelvls July 24, 2024 16:58

### Feature

- Add `SecretRef` support for Venafi TPP issuer CA Bundle ([#7036](https://github.com/cert-manager/cert-manager/pull/7036), [`@sankalp-at-gh`](https://github.com/sankalp-at-gh))
Copy link
Member

Choose a reason for hiding this comment

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

nit, don't feel the need to change anything: I wish we could write release notes that are slightly more user-focused, but I realize that it isn't that easy since each contributor writes their own release notes. Among others:

  • Most of these items focus on what was technically done to achieve the feature (e.g., "add X" rather than explaining whether/how it can impact the user.
  • "Features" is super heterogenous; I think the Helm improvements should be in their own section or subsection, and maybe also group "Runtime Improvements", and "API Changes".

Example:

  • Add SecretRef support for Venafi TPP issuer CA Bundle

should be reworded as:

  • The Venafi issuer now lets you load your custom CA bundle to connect to TPP from a Secret resource using the new field secretRef.

I think we would benefit greatly from having a technical writter look at our release notes from time to time. Maybe we could get @ditatechwriter (Michael) to give some advice on this.

@maelvls
Copy link
Member

maelvls commented Jul 25, 2024

Since this is an alpha, I don't think it's super important to write great release notes. But for the final release, we surely do! I've left a comment in that sense.

/lgtm
/approve

@cert-manager-prow cert-manager-prow bot added the lgtm Indicates that a PR is ready to be merged. label Jul 25, 2024
@cert-manager-prow
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: maelvls

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@cert-manager-prow cert-manager-prow bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 25, 2024
@cert-manager-prow cert-manager-prow bot merged commit c75a056 into cert-manager:release-next Jul 25, 2024
7 checks passed
@wallrj wallrj deleted the release-notes-1.16.0-alpha.0 branch July 25, 2024 11:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. lgtm Indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants